Commit 18eb0cf2 authored by Lars-Erik Helander's avatar Lars-Erik Helander Committed by Michele Carignani
Browse files

Added specifications for VNF Indicator and VNF Indicator Notification 

Change-Id: Id25ff21f7da03db748ea3072a185e215eb65c55e
parent 0919638a

src/SOL002/VNFIndicator/VNFIndicator.yaml

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



info: 

  version: "2.3.1"

  title: "VNF Indicator interface"

  description: "VNF Indicator interface of ETSI NFV SOL002"

  termsOfService: "http://etsi.org"

  contact: 

    name: "NFV-SOL WG"

  license:

    name: "ETSI Forge copyright notice"

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





basePath: /vnfind/v1



schemes: 

  - http

  - https



consumes: 

  - application/json



produces: 

  - application/json





paths:



    /indicators:

      get:

        summary: Query multiple indicators

        description: Get a list of indicators. Support of attribute based filtering via query parameters.

#        parameters:

#         - name: id.eq

#           in: query

#           description: Attribute based filtering for indicator identifer as specified in VNFD.

#           type: array

#           items:

#             type: string

#         - name: name.eq

#           in: query

#           description: Attribute based filtering for indicator name as specified in VNFD.

#           type: array

#           items:

#             type: string

#         - name: value.eq

#           in: query

#           description: Attribute based filtering for indicator value equality.

#           type: array

#           items:

#             type: string

#         - name: value.neq

#           in: query

#           description: Attribute based filtering for indicator value unequality.

#           type: array

#           items:

#             type: string

#         - name: value.gt

#           in: query

#           description: Attribute based filtering for indicator value greater than.

#           type: array

#           items:

#             type: string

#         - name: value.gte

#           in: query

#           description: Attribute based filtering for indicator value greater then or equal.

#           type: array

#           items:

#             type: string

#         - name: value.lt

#           in: query

#           description: Attribute based filtering for indicator value less than.

#           type: array

#           items:

#             type: string

#         - name: value.lte

#           in: query

#           description: Attribute based filtering for indicator value less than or equal.

#           type: array

#           items:

#             type: string

#         - name: vnfInstanceId.eq

#           in: query

#           description: Attribute based filtering for indicators belonging to specified VNF instance.

#           type: array

#           items:

#             type: string

        responses:

          200:

            description: >

              The list of VNF indicators was queried successfully.

              The response body shall contain the representations of all VNF indicators that match

              the attribute-based filtering parameters.

            schema:

              type: array

              items:

                $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'                  

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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





    /indicators/{vnfInstanceId}:

      parameters:

       - name: vnfInstanceId

         in: path

         description: >

           Identifier of the VNF instance to which the VNF indicators applies.

           NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a 

           POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body 

           of that response.

         type: string

         required: true

      get:

        summary: Query multiple indicators related to a VNF instance.

        description: >

           Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.

#        parameters:

#         - name: id.eq

#           in: query

#           description: Attribute based filtering for indicator identifer as specified in VNFD.

#           type: array

#           items:

#             type: string

#         - name: name.eq

#           in: query

#           description: Attribute based filtering for indicator name as specified in VNFD.

#           type: array

#           items:

#             type: string

#         - name: value.eq

#           in: query

#           description: Attribute based filtering for indicator value equality.

#           type: array

#           items:

#             type: string

#         - name: value.neq

#           in: query

#           description: Attribute based filtering for indicator value unequality.

#           type: array

#           items:

#             type: string

#         - name: value.gt

#           in: query

#           description: Attribute based filtering for indicator value greater than.

#           type: array

#           items:

#             type: string

#         - name: value.gte

#           in: query

#           description: Attribute based filtering for indicator value greater then or equal.

#           type: array

#           items:

#             type: string

#         - name: value.lt

#           in: query

#           description: Attribute based filtering for indicator value less than.

#           type: array

#           items:

#             type: string

#         - name: value.lte

#           in: query

#           description: Attribute based filtering for indicator value less than or equal.

#           type: array

#           items:

#             type: string

        responses:

          200:

            description: >

              The list of VNF indicators was queried successfully.

              The response body shall contain the representations of all VNF indicators that match

              the attribute-based filtering parameters.

            schema:

              type: array

              items:

                $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'                  

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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





    /indicators/{vnfInstanceId}/{indicatorId}:

      parameters:

       - name: vnfInstanceId

         in: path

         description: >

           Identifier of the VNF instance to which the VNF indicators applies.

           NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a 

           POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body 

           of that response.

         type: string

         required: true

       - name: indicatorId

         in: path

         description: >

           Identifier of the VNF indicator.

# LEH        NOTE from SOL002 is strange

         type: string

         required: true

      get:

        summary: Query multiple indicators related to a VNF instance.

        description: >

          Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.

          NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a 

          POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body 

          of that response.

        responses:

          200:

            description: >

              The list of VNF indicators was queried successfully.

              The response body shall contain the representations of all VNF indicators that match

              the attribute-based filtering parameters.

            schema:

              $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'                  

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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





    /subscriptions:

      post:

        summary: Create a new subscription

        description: Create a new subscription

        parameters:

         - name: subscription

           in: body

           description: Subscription data.

           required: true

           schema: 

             $ref: 'definitions/VnfIndicatorSubscriptionRequest_def.yaml#/definitions/VnfIndicatorSubscriptionRequest'                  

        responses:

          201:

            description: >

              The subscription was created successfully.

              The response body shall contain a representation of the created subscription resource.

            schema:

              $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 

            headers:

              Location:

                description: >

                  Pointer to the created subscription resource.

                type: string

                format: URI                 

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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

      get:

        summary: Query subscriptions.

        description: >

          The GET method queries the list of active subscriptions of the functional block

          that invokes the method. It can be used e.g. for resynchronization after error situations.

#        parameters:

#         - name: id.eq

#           in: query

#           description: >

#             Attribute based filtering for subscription identifiers.

#           type: array

#           items:

#             type: string

#         - name: callbackUri.eq

#           in: query

#           description: >

#             Attribute based filtering for the subscription's call back URIs.

#           type: array

#           items:

#             type: string

#         - name: filter.indicatorIds.cont

#           in: query

#           description: >

#             Attribute based filtering for indicator identifiers.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfdIds.cont

#           in: query

#           description: >

#             Attribute based filtering for VNFD identifiers.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProvider.eq

#           in: query

#           description: >

#             Attribute based filtering for VNF providers.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.vnfProductName.eq

#           in: query

#           description: >

#             Attribute based filtering for VNF product name.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.versions.vnfSoftwareVersion.cont

#           in: query

#           description: >

#             Attribute based filtering for VNF software versions.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.versions.vnfdVersion.cont

#           in: query

#           description: >

#             Attribute based filtering for VNFD versions.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfInstanceIds.cont

#           in: query

#           description: >

#             Attribute based filtering for VNF instance identifiers.

#           type: array

#           items:

#             type: string

#         - name: filter.vnfInstanceSubscriptionFilter.vnfInstanceNames.cont

#           in: query

#           description: >

#             Attribute based filtering for VNF instance names.

#           type: array

#           items:

#             type: string

        responses:

          200:

            description: >

              The list of subscriptions was queried successfully. The response body shall contain

              the representations of all active subscriptions of the functional block that invokes

              the method which match the attribute filter.

            schema:

              type: array

              items:

                $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription'                  

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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





    /subscriptions/{subscriptionId}:

      get:

        summary: Query subscriptions.

        description: >

          This resource represents an individual subscription. The client can use this resource to 

          read and to terminate a subscription to notifications related to VNF indicator value changes.

        parameters:

         - name: subscriptionId

           description: >

             Identifier of this subscription.

             NOTE:

              This identifier can be retrieved from the resource referenced by the "Location" HTTP header

              in the response to a POST request creating a new subscription resource. It can also be retrieved

              from the "id" attribute in the payload body of that response.

           in: path

           type: string

           required: true

        responses:

          200:

            description: >

              The subscriptions was queried successfully. The response body shall contain

              the representation of the requested subscription.

            schema:

              $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription'                  

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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

      delete:

        summary: Delete a subscription 

        description: Terminate an individual subscription.

        parameters:

         - name: subscriptionId

           description: >

             Identifier of this subscription.

             NOTE:

              This identifier can be retrieved from the resource referenced by the "Location" HTTP header

              in the response to a POST request creating a new subscription resource. It can also be retrieved

              from the "id" attribute in the payload body of that response.

           in: path

           type: string

           required: true

        responses:

          204:

            description: >

              The subscription was deleted successfully.

              The response body shall be empty.

          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/VNFIndicator_resp.yaml#/responses/409' }

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

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

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

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

src/SOL002/VNFIndicator/definitions/SubscriptionAuthentication_def.yaml

0 → 100644
+77 −0
Original line number Diff line number Diff line 
definitions:



  SubscriptionAuthentication:

    description: >

      If an API consumer requires the API producer to authorize for sending notifications to that API consumer,

      it shall include in the subscription request data according to the following structure.

    type: object

    required:

      - authType

    properties:

      authType:

        description: >

          Defines the type of Authentication/Authorization to use when sending a notification.

          Permitted values:

            * BASIC

                * In every POST request that sends a notification, use HTTP Basic authentication with

                  the client credentials.

                * The API producer shall pass its client credentials in every POST request that sends a 

                   notification, as defined in IETF RFC 7617.

                * NOTE: The clientId and clientPassword passed in a subscription shall not be the same as the

                  clientId and clientPassword that are used to obtain authorization for API requests.

                  Client credentials may differ between subscriptions. The value of clientPassword should be

                  generated by a random process.

            * OAUTH2_CLIENT_CREDENTIALS

                * In every POST request that sends a notification, use an 

                  OAuth 2.0 Bearer token, obtained using the client credentials grant type.

                * The API producer shall, prior to sending any notification, obtain an access token from 

                  the token endpoint using the OAuth 2.0 client credentials grant type as defined in 

                  IETF RFC 6749. The API consumer should include expiry information with the token response.

                * The API producer shall include that access token as a Bearer token in every POST request

                  that sends a notification (according to IETF RFC 6750).

                * If the access token is expired, the API consumer shall reject the notification. In that case,

                  the API producer shall obtain a new access token, and repeat sending the notification.

                * If the token expiry time is known to the API producer, it may obtain proactively a new access token.

        type: string

        enum:

         - BASIC

         - OAUTH2_CLIENT_CREDENTIALS

      paramsBasic:

        description: >

          Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and

          the contained information has not been provisioned out of band. Shall be absent otherwise.

        type: object

        properties:

          userName:

            description: >

              Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned

              out of band.

            type: string

          password:

            description: >

              Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned

              out of band.

            type: string

      paramsOauth2Client Credentials:

        description: >

          Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if 

          authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned 

          out of band. Shall be absent otherwise.

        type: object

        properties:

          clientId:

            description: >

              Client identifier to be used in the access token request of the OAuth 2.0 client credentials

              grant type. Shall be present if it has not been provisioned out of band. See NOTE.

            type: string

          clientPassword:

            description: >

              Client password to be used in the access token request of the OAuth 2.0 client credentials

              grant type. Shall be present if it has not been provisioned out of band. See NOTE.

            type: string

          tokenEndpoint:

            description: >

              The token endpoint from which the access token can be obtained. Shall be present if it has

              not been provisioned out of band.

            type: string

            format: URI

src/SOL002/VNFIndicator/definitions/VnfIndicatorNotificationsFilter_def.yaml

0 → 100644
+24 −0

File added.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscriptionRequest_def.yaml

0 → 100644
+27 −0

File added.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscription_def.yaml

0 → 100644
+37 −0

File added.

Preview size limit exceeded, changes collapsed.