Commit 2f6f9979 authored by Samir Medjiah's avatar Samir Medjiah
Browse files

SOL003: Added "API Version" end point

parent 43e7c51c

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

+51 −0
Original line number Diff line number Diff line
@@ -39,6 +39,57 @@ 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: >

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



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

# Alarms                                                                      #

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

src/SOL003/VNFIndicator/VNFIndicator.yaml

+51 −0
Original line number Diff line number Diff line
@@ -38,6 +38,57 @@ 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: >

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



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

# VNF indicators                                                              #

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

src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+51 −0
Original line number Diff line number Diff line
@@ -39,6 +39,57 @@ 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: >

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



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

# VNF instances                                                               #

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

src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml

+51 −0
Original line number Diff line number Diff line
@@ -39,6 +39,57 @@ 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: >

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



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

# Resource: Grants                                                            #

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

src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml

+51 −0
Original line number Diff line number Diff line
@@ -39,6 +39,57 @@ 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: >

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



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

# VNF packages                                                                #

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