VTP Profile REST API

swagger: '2.0'
info:
  version: 1.1.0
  title: 'VTP Profile support'
basePath: /v1
tags:
  - name: VTP Profile
paths:
  '/vtp/profiles':
    get:
      tags:
        - VTP Profile
      summary: List available profiles
      description: ''
      operationId: listTestProfiles
      produces:
        - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            type: array
            items:
              $ref: '#/definitions/VTPTestProfile'
        '500':
          description: Failed to perform the operation
          schema:
            $ref: '#/definitions/VTPError'
    post:
      tags:
        - VTP Profile
      summary: Create profile.
      description: ''
      operationId: createProfile
      consumes:
        - application/json
      produces:
        - application/json
      parameters: []
      responses:
        '409':
          description: Test profile does already exist with given name
          schema:
            $ref: '#/definitions/VTPError'
        '500':
          description: Failed to perform the operation
          schema:
            $ref: '#/definitions/VTPError'
  '/vtp/profiles/{profileName}':
    get:
      tags:
        - VTP Profile
      summary: ' Retrieve profile details'
      description: ''
      operationId: getTestProfile
      produces:
        - application/json
      parameters:
        - name: profileName
          in: path
          description: Test profile name
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/VTPTestProfile'
        '404':
          description: Test profile does not exist
          schema:
            $ref: '#/definitions/VTPError'
        '500':
          description: Failed to perform the operation
          schema:
            $ref: '#/definitions/VTPError'
    put:
      tags:
        - VTP Profile
      summary: 'Update profile. To remove a profile parameter, set its value to null or empty.'
      description: ''
      operationId: updateProfile
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: profileName
          in: path
          description: Test profile name
          required: true
          type: string
      responses:
        '500':
          description: Failed to perform the operation
          schema:
            $ref: '#/definitions/VTPError'
    delete:
      tags:
        - VTP Profile
      summary: Delete profile
      description: ''
      operationId: deleteProfile
      parameters:
        - name: profileName
          in: path
          description: Test profile name
          required: true
          type: string
      responses:
        '404':
          description: Test profile does not exist
          schema:
            $ref: '#/definitions/VTPError'
        '500':
          description: Failed to perform the operation
          schema:
            $ref: '#/definitions/VTPError'

definitions:
  VTPTestProfile:
    type: object
    properties:
      name:
        type: string
      properties:
        type: array
        items:
          $ref: '#/definitions/VTPTestProfileProperty'
  VTPTestProfileProperty:
    type: object
    properties:
      scenario:
        type: string
      testSuiteName:
        type: string
      testCaseName:
        type: string
      inputParameterName:
        type: string
      value:
        type: string
  VTPError:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      httpStatus:
        type: integer
        format: int32
ONAP Wiki

VTP Profile REST API

Analytics

Related content
