Commit 0f42dc90 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated api-versions endpoint openapi: put common structure of path and... 

updated api-versions endpoint openapi: put common structure of path and referenced in other openapis
parent ad8ea6b0

src/SOL002/APIVersion/APIVersion.yaml

+14 −48
Original line number Diff line number Diff line
@@ -17,7 +17,6 @@ info: 
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: /{apiName}

schemes:

  - http

  - https
@@ -29,50 +28,17 @@ paths: 
  ###############################################################################

  # API Versions                                                                #

  ###############################################################################

  '/api-versions':

    parameters:

      - name: Version

        description: >

          Version of the API requested to use when responding to this request.

        in: header

        required: false

        type: string

    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

            Version:

              description: The used API version.

              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' }
 
  '/vnfconfig/api-versions':

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



  '/vnffm/api-versions':

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



  '/vnfind/api-versions':

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



  '/vnflcm/api-versions':

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



  '/vnfpm/api-versions':

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
 
 No newline at end of file

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+1 −46
Original line number Diff line number Diff line
@@ -30,52 +30,7 @@ paths: 
  # API Versions                                                                #

  ###############################################################################

  '/api-versions':

    parameters:

      - name: Version

        description: >

          Version of the API requested to use when responding to this request.

        in: header

        required: true

        type: string

    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

            Version:

              description: The used API version.

              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' }

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



  ###############################################################################

  # VNF Configuration                                                           #

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+4 −49
Original line number Diff line number Diff line
@@ -40,52 +40,7 @@ paths: 
  # API Versions                                                                #

  ###############################################################################

  '/api-versions':

    parameters:

      - name: Version

        description: >

          Version of the API requested to use when responding to this request.

        in: header

        required: true

        type: string

    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

            Version:

              description: The used API version.

              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' }

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



###############################################################################

# Alarms                                                                      #

src/SOL002/VNFIndicator/VNFIndicator.yaml

+1 −46
Original line number Diff line number Diff line
@@ -44,52 +44,7 @@ paths: 
  # API Versions                                                                #

  ###############################################################################

  '/api-versions':

    parameters:

      - name: Version

        description: >

          Version of the API requested to use when responding to this request.

        in: header

        required: true

        type: string

    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

            Version:

              description: The used API version.

              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' }

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



  ###############################################################################

  # VNF Indicators                                                              #

src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+5 −49
Original line number Diff line number Diff line
@@ -39,52 +39,8 @@ paths: 
  # API Versions                                                                #

  ###############################################################################

  '/api-versions':

    parameters:

      - name: Version

        description: >

          Version of the API requested to use when responding to this request.

        in: header

        required: true

        type: string

    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

            Version:

              description: The used API version.

              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' }

    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'



###############################################################################

# VNF instances                                                               #

###############################################################################