Skip to content
GitLab
Commit fe14bcb4 authored by moscatelli's avatar moscatelli
Browse files

SOL003_239/SOL003_240: VirtualisedResourcesQuotaAvailableNotification Subscriptions methods updated

parent 83169a0b
Pipeline #1217 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml
View file @ fe14bcb4
......@@ -25,8 +25,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 003 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
description: ETSI GS NFV-SOL 003 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
basePath: "/vrqan/v1"
......@@ -51,19 +51,21 @@ paths:
'/subscriptions':
post:
description: >
Subscribe
Subscribe.
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 11.4.2.3.1-1 and 11.4.2.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 11.4.3 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: Accept
......@@ -105,9 +107,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.
......@@ -135,6 +137,14 @@ paths:
schema:
$ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription"
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"
......@@ -146,19 +156,24 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
500:
$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 allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
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 11.4.2.3.2-1 and 11.4.2.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
......@@ -169,7 +184,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 VrQuotaAvailSubscription
......@@ -182,7 +197,7 @@ paths:
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.
according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
in: query
required: false
type: string
......@@ -197,14 +212,15 @@ 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 virtualized resource quota
available subscriptions as defined in clause 11.5.2.3.
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 virtualised resource quota 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
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.
......
src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml
View file @ fe14bcb4
......@@ -25,8 +25,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 003 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
description: ETSI GS NFV-SOL 003 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
basePath: "/callback/v1"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment