Commit 5166eb94 authored by moscatelli's avatar moscatelli
Browse files

SOL005_27 and SOL005_94: API version resource added to NSD mgmt and NS Performarce mgmt interfaces

parent efe5fa2f

src/SOL005/APIVersion/APIVersion.yaml

0 → 100644
+79 −0
Original line number Diff line number Diff line 
swagger: "2.0"

info:

  version: "1.2.0"

  title: "SOL005 - API version interface"

  description: >

    SOL005 - API version 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 005 V2.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

basePath: /{apiName}

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.

      parameters:

        - name: Version

          description: >

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

          in: header

          required: false

          type: string

      responses:

        200:

          description: >

            200 OK



            API version information was read successfully.

            The response body shall contain API version information, as defined in clause 4.4.1.7.

          schema:

            $ref: '../definitions/SOL005_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/SOL005_resp.yaml#/responses/400' }

        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }

        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }

        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }

        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }

        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }

        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }

        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }

        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }

        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }

        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }

        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }

        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }

        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
 
 No newline at end of file

src/SOL005/NSDManagement/NSDManagement.yaml

+59 −6
Original line number Diff line number Diff line 
swagger: "2.0"



info:

  version: 1.0.0

  title: SOL005 - NSD Management Interface

  version: "1.2.0"

  title: "SOL005 - NSD Management Interface"

  description: >

    SOL005 - NSD Management Interface 

    IMPORTANT: Please note that this file might be not aligned to the current
@@ -11,21 +11,74 @@ info: 
    Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

  license:

    name: ETSI Forge copyright notice

    name: "ETSI Forge copyright notice"

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

  contact:

    name: NFV-SOL WG

    name: "NFV-SOL WG"

externalDocs:

  description: ETSI GS NFV-SOL 005 V2.4.1

  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf

  description: ETSI GS NFV-SOL 005 V2.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

basePath: /nsd/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.

      parameters:

        - name: Version

          description: >

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

          in: header

          required: false

          type: string

      responses:

        200:

          description: >

            200 OK

            

            API version information was read successfully.

            The response body shall contain API version information, as defined in clause 4.4.1.7.

          schema:

            $ref: '../definitions/SOL005_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/SOL005_resp.yaml#/responses/400' }

        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }

        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }

        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }

        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }

        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }

        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }

        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }

        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }

        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }

        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }

        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }

        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }

        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }



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

  # NS Descriptors                                                              #

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

src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml

+59 −6
Original line number Diff line number Diff line 
swagger: "2.0"



info:

  version: 1.0.0

  title: SOL005 - NS Performance Management Interface

  version: "1.2.0"

  title: "SOL005 - NS Performance Management Interface"

  description: >

    SOL005 - NS Performance Management Interface

    IMPORTANT: Please note that this file might be not aligned to the current
@@ -11,21 +11,74 @@ info: 
    Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

  license:

    name: ETSI Forge copyright notice

    name: "ETSI Forge copyright notice"

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

  contact:

    name: NFV-SOL WG

    name: "NFV-SOL WG"

externalDocs:

  description: ETSI GS NFV-SOL 005 V2.4.1

  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf

  description: ETSI GS NFV-SOL 005 V2.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

basePath: /nspm/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.

      parameters:

        - name: Version

          description: >

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

          in: header

          required: false

          type: string

      responses:

        200:

          description: >

            200 OK



            API version information was read successfully.

            The response body shall contain API version information, as defined in clause 4.4.1.7.

          schema:

            $ref: '../definitions/SOL005_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/SOL005_resp.yaml#/responses/400' }

        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }

        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }

        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }

        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }

        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }

        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }

        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }

        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }

        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }

        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }

        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }

        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }

        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }



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

  # PM Jobs                                                                     #

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