Commit fe14bcb4 authored by moscatelli's avatar moscatelli
Browse files

SOL003_239/SOL003_240: VirtualisedResourcesQuotaAvailableNotification Subscriptions methods updated

parent 83169a0b

src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml

+48 −32
Original line number Original line Diff line number Diff line
@@ -25,8 +25,8 @@ info: 
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

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





externalDocs:

externalDocs:

  description: ETSI GS NFV-SOL 003 V2.5.1

  description: ETSI GS NFV-SOL 003 V2.6.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf





basePath: "/vrqan/v1"

basePath: "/vrqan/v1"
@@ -51,19 +51,21 @@ paths: 
  '/subscriptions':

  '/subscriptions':

    post:

    post:

      description: >

      description: >

        Subscribe

        Subscribe.





        The POST method creates a new subscription.

        The POST method creates a new subscription.

        Creation of two subscription resources with the same callbackURI and

        This method shall follow the provisions specified in the tables 11.4.2.3.1-1 and 11.4.2.3.1-2

        the same filter can result in performance degradation and will provide

        for URI query parameters, request and response data structures, and response codes.

        duplicates of notifications to the VNFM, and might make sense only in

        As the result of successfully executing this method, a new "Individual subscription"

        very rare use cases. Consequently, the NFVO may either allow creating

        resource as defined in clause 11.4.3 shall have been created. This method shall not

        a subscription resource if another subscription resource with the same

        trigger any notification.

        filter and callbackUri already exists (in which case it shall return

        Creation of two "Individual subscription" resources with the same callbackURI and

        the “201 Created” response code), or may decide to not create a

        the same filter can result in performance degradation and will provide duplicates

        duplicate subscription resource (in which case it shall return a

        of notifications to the VNFM, and might make sense only in very rare use cases.

        “303 See Other” response code referencing the existing subscription

        Consequently, the NFVO may either allow creating a new "Individual subscription"

        resource if another "Individual subscription" resource with the same filter and

        callbackUri already exists (in which case it shall return the "201 Created" response code),

        or may decide to not create a duplicate "Individual subscription" resource (in which case

        it shall return a "303 See Other" response code referencing the existing "Individual subscription"

        resource with the same filter and callbackUri).

        resource with the same filter and callbackUri).

      parameters:

      parameters:

        - name: Accept

        - name: Accept
@@ -105,9 +107,9 @@ paths: 
          description: >

          description: >

            201 CREATED

            201 CREATED





            Representation of the created subscription resource.

            Shall be returned when the subscription has been created successfully.

            The HTTP response shall include a "Location" HTTP header that

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

            points to the created subscription resource.

            The HTTP response shall include a "Location" HTTP header that points to the created resource.

          headers:

          headers:

            Content-Type:

            Content-Type:

              description: The MIME type of the body of the response.

              description: The MIME type of the body of the response.
@@ -135,6 +137,14 @@ paths: 
          schema:

          schema:

            $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription"

            $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription"

        303:

        303:

          description: >

            303 SEE OTHER



            Shall be returned when a subscription with the same callbackURI and the same

            filter already exists and the policy of the NFVO is to not create redundant subscriptions.

            The HTTP response shall include a "Location" HTTP header that contains the resource URI

            of the existing "Individual subscription" resource.

            The response body shall be empty.

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"

        400:

        400:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
@@ -146,19 +156,24 @@ paths: 
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        422:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"

        406:

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        500:

        500:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

        503:

        503:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

        504:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"



    get:

    get:

      description: >

      description: >

        Query Subscription Information

        Query Subscription Information.



        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.

        The GET method allows the server to test the notification endpoint

        This method shall follow the provisions specified in the tables 11.4.2.3.2-1 and 11.4.2.3.2-2

        that is provided by the client, e.g. during subscription.

        for URI query parameters, request and response data structures, and response codes.

      parameters:

      parameters:

        - name: Authorization

        - name: Authorization

          description: >

          description: >
@@ -169,7 +184,7 @@ paths: 
          type: string

          type: string

        - name: filter

        - name: filter

          description: >

          description: >

            Attribute-based filtering expression according to clause 4.3.2.

            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.

            The VNFM shall support receiving this parameter as part of the 

            The VNFM shall support receiving this parameter as part of the 

            URI query string. The NFVO may supply this parameter. 

            URI query string. The NFVO may supply this parameter. 

            All attribute names that appear in the VrQuotaAvailSubscription 

            All attribute names that appear in the VrQuotaAvailSubscription
@@ -182,7 +197,7 @@ paths: 
          description: >

          description: >

            Marker to obtain the next page of a paged response. Shall be 

            Marker to obtain the next page of a paged response. Shall be 

            supported by the VNFM if the VNFM supports alternative 2 (paging) 

            supported by the VNFM if the VNFM supports alternative 2 (paging) 

            according to clause 4.7.2.1 for this resource.

            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.

          in: query

          in: query

          required: false

          required: false

          type: string

          type: string
@@ -197,14 +212,15 @@ paths: 
          description: >

          description: >

            200 OK

            200 OK





            The list of subscriptions was queried successfully.

            Shall be returned when the list of subscriptions has been queried successfully.

            The representations body shall contain in an array the representations

            The response body shall contain in an array the representations of all active

            of all active subscriptions of the functional block that invokes the

            subscriptions of the functional block that invokes the method, i.e. zero or more

            method, i.e. zero or more representations of virtualized resource quota

            representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3.

            available subscriptions as defined in clause 11.5.2.3.

            If the "filter" URI parameter was supplied in the request, the data in the response body shall

            If the VNFM supports alternative 2 (paging) according to clause 

            have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.

            4.7.2.1 for this resource, inclusion of the Link HTTP header in 

            If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013

            this response shall follow the provisions in clause 4.7.2.3.

            for this resource, inclusion of the Link HTTP header in this response shall follow the provisions

            in clause 5.4.2.3 of ETSI GS NFV-SOL 013.

          headers:

          headers:

            Content-Type:

            Content-Type:

              description: The MIME type of the body of the response.

              description: The MIME type of the body of the response.

src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml

+2 −2
Original line number Original line Diff line number Diff line
@@ -25,8 +25,8 @@ info: 
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

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





externalDocs:

externalDocs:

  description: ETSI GS NFV-SOL 003 V2.5.1

  description: ETSI GS NFV-SOL 003 V2.6.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf





basePath: "/callback/v1"

basePath: "/callback/v1"