Commit 23cb56d3 authored by moscatelli's avatar moscatelli
Browse files

SOL003_221 -> SOL003_223: Subscriptions methods updated

parent 0387664f

src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml

+49 −30
Original line number Diff line number Diff line
@@ -1302,15 +1302,22 @@ paths: 




        The POST method creates a new subscription.

        Creation of two subscription resources with the same callbackURI and

        the same filter can result in performance degradation and will provide

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

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

        a subscription resource if another 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 subscription resource (in which case it shall return a

        “303 See Other” response code referencing the existing subscription

        This method shall follow the provisions specified in the tables

        10.4.7.3.1-1 and 10.4.7.3.1-2 for URI query parameters, request

        and response data structures, and response codes.

        As the result of successfully executing this method, a new

        "Individual subscription" resource as defined in clause 10.4.8

        shall have been created. This method shall not trigger any notification.

        Creation of two "Individual subscription" resources with the same

        callbackURI and the same filter can result in performance degradation

        and will provide duplicates of notifications to the VNFM, and might

        make sense only in very rare use cases. 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).

      parameters:

        - name: PkgmSubscriptionRequest
@@ -1354,9 +1361,9 @@ paths: 
          description: >

            201 CREATED



            Representation of the created subscription resource.

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

            points to the created subscription resource.

            Shall be returned when the subscription has been created successfully.

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

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

          headers:

            Content-Type:

              description: The MIME type of the body of the response.
@@ -1386,6 +1393,14 @@ paths: 
            items:

              $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"

        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"

        400:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
@@ -1396,7 +1411,7 @@ paths: 
        404:

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

        405:

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

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

        406:

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

        416:
@@ -1405,14 +1420,16 @@ paths: 
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

        503:

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

        504:

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



    get:

      description: >

        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.

        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.

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

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

      parameters:

        - name: Accept

          description: >
@@ -1430,7 +1447,7 @@ paths: 
          type: string

        - name: filter

          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 

            URI query string. The NFVO may supply this parameter. 

            All attribute names that appear in the PkgmSubscription and in
@@ -1442,8 +1459,8 @@ paths: 
        - name: nextpage_opaque_marker

          description: >

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

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

            according to clause 4.7.2.1 for this resource.

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

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

          in: query

          required: false

          type: string
@@ -1458,14 +1475,16 @@ paths: 
          description: >

            200 OK



            The list of subscriptions was queried successfully.

            The representations body shall contain in an array the representations

            of all active subscriptions of the functional block that invokes the

            method , i.e. zero or more representations of VNF package Management

            subscriptions as defined in clause 10.5.2.4.

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

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

            this response shall follow the provisions in clause 4.7.2.3.

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

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

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

            representations of VNF package management subscriptions as defined in clause 10.5.2.4.

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

            body shall have been transformed according to the rules specified in clause 5.2.2

            of ETSI GS NFV-SOL 013

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

            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:

            Content-Type:

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