swagger: "2.0"
info:
  version: "1.1.0"
  title: "SOL002 - VNF Configuration interface"
  description: >
    SOL002 - VNF Configuration Interface
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 002 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
basePath: /vnfconfig/v1
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      responses:
        200:
          description: >
            API version information was read successfully.
            The response body shall contain 4.4 API version
            information, as defined in clause 4.4.1.13.
          schema:
            $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
        401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
        403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
        404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
        405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
        406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
        413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
        414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
        416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
        422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
        429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' }
        500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
        503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
        504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' }

  ###############################################################################
  # VNF Configuration                                                           #
  ###############################################################################
  '/configuration':
    get:
      summary: Read VNF/VNFC configuration from VNF
      description: >
        The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
      responses:
        200:
          description: >
            OK
            Configuration information about a VNF instance was read successfully.
            The response body shall contain a representation of the configuration resource.
          schema:
            $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfiguration'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
        401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
        403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
        404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
        405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
        406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
        409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' }
        413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
        414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
        416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
        422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
        429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' }
        500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
        503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
        504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' }
    patch:
      summary: Modify VNF/VNFC configuration.
      description: This method sets or modifies a configuration resource.
      parameters:
        - name: configModifications
          description: >
            The parameter for the configuration modification, as defined in
            clause 9.5.2.2.
          required: true
          in: body
          schema:
            $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
      responses:
        200:
          description: >
            OK

            The request was accepted and completed. The response body shall contain the parameters
            of the configuration modification that was applied to the configuration resource.
          schema:
            $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
        401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
        403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
        404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
        405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
        406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
        413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
        414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
        416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
        422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
        429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' }
        500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
        503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
        504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' }



