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

SOL003_131/SOL003_132: Subscriptions POST and GET description fields updated

parent adc65d8a
Pipeline #1186 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ afa28516
......@@ -916,14 +916,21 @@ paths:
$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"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
###############################################################################
# Subscriptions #
###############################################################################
......@@ -931,20 +938,20 @@ paths:
#SOL003 location: 6.4.7
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 NFVO, and might make sense only in
very rare use cases. Consequently, the VNFM 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
resource with the same filter and callbackUri).
This method shall follow the provisions specified in the tables 6.4.7.3.1-1 and 6.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 6.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 NFVO,
and might make sense only in very rare use cases. Consequently, the VNFM 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: PmSubscriptionRequest
description: >
......@@ -985,11 +992,11 @@ paths:
description: >
201 CREATED
The subscription was created successfully. A representation of the
created subscription resource shall be returned in the response
body.
The HTTP response shall include a "Location" HTTP header that
contains the resource URI of the created subscription resource.
Shall be returned when the subscription has been created successfully.
A representation of the created "Individual subscription" resource shall be
returned in the response body, as defined in clause 6.5.2.3.
The HTTP response shall include a "Location" HTTP header that contains the
resource URI of the created "Individual subscription" resource.
headers:
Location:
description: The resource URI of the created VNF instance
......@@ -1034,14 +1041,14 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
Query Subscription Information
The client can use this method to query the list of active
subscriptions to Performance management notifications subscribed by
the client.
Query Subscription Information.
TThe client can use this method to query the list of active subscriptions
to Performance management notifications subscribed by the client.
This method shall follow the provisions specified in the tables 6.4.7.3.2-1 and 6.4.7.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Accept
description: >
......@@ -1059,7 +1066,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 PmSubscription and in
......@@ -1072,7 +1079,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
......@@ -1087,15 +1094,15 @@ paths:
description: >
200 OK
The list of subscriptions was 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 PM subscriptions
as defined in 6.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
PM subscriptions as defined in clause 6.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: >
......
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