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

SOL003_136 -> SOL003_192: Individual subscription and Notification endpoints updated

parent afa28516
Pipeline #1187 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ bbfcb22a
......@@ -1033,14 +1033,20 @@ 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"
get:
description: >
......@@ -1141,14 +1147,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"
###############################################################################
# Individual subscription #
###############################################################################
......@@ -1159,18 +1172,18 @@ paths:
description: >
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"
new "Individual subscription" resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
in: path
type: string
required: true
get:
description: >
Query Subscription Information
The client can use this method for reading an individual subscription
about Performance management notifications subscribed by the client.
Query Subscription Information.
The client can use this method for reading an individual subscription about
Performance management notifications subscribed by the client.
This method shall follow the provisions specified in the tables 6.4.8.3.2-1 and 6.4.8.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Accept
description: >
......@@ -1197,8 +1210,9 @@ paths:
description: >
200 OK
The subscription was read successfully. The response body shall
contain a representation of the subscription resource.
Shall be returned when the subscription has been read successfully.
The response body shall contain a representation of the "Individual subscription" resource,
as defined in clause 6.5.2.3.
headers:
Content-Type:
description: >
......@@ -1229,20 +1243,33 @@ 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"
delete:
description: >
Terminate Subscription
Terminate Subscription.
This method terminates an individual subscription.
This method shall follow the provisions specified in the tables 6.4.8.3.5-1 and 6.4.8.3.5-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual subscription" resource
shall not exist any longer. This means that no notifications for that subscription shall
be sent to the formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
API consumer for a certain time period after the deletion.
parameters:
- name: Authorization
description: >
......@@ -1262,7 +1289,7 @@ paths:
description: >
204 NO CONTENT
The subscription resource was deleted successfully.
Shall be returned when the "Individual subscription" resource has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -1285,11 +1312,17 @@ 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"
\ No newline at end of file
src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml
View file @ bbfcb22a
......@@ -26,7 +26,7 @@ info:
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
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
basePath: "/callback/v1"
......@@ -46,11 +46,12 @@ paths:
#SOL003 location: 6.4.9
post:
description: >
Notify
The POST method delivers a notification regarding a performance
management event from the server to the client.
Notify.
The POST method delivers a notification regarding a performance management
event from the server to the client.API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: PerformanceInformationAvailableNotification
description: >
......@@ -84,7 +85,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -116,8 +117,10 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
The GET method allows the server to test the notification endpoint that is provided by the client,
e.g. during subscription.
This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
......@@ -137,7 +140,8 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
......@@ -167,6 +171,7 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Notification endpoint ThresholdCrossedNotification #
###############################################################################
......@@ -174,11 +179,12 @@ paths:
#SOL003 location: 6.4.9
post:
description: >
Notify
The POST method delivers a notification regarding a performance
management event from the server to the client.
Notify.
The POST method delivers a notification regarding a performance management
event from the server to the client.API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: ThresholdCrossedNotification
description: >
......@@ -212,7 +218,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -244,8 +250,10 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
The GET method allows the server to test the notification endpoint that is provided by the client,
e.g. during subscription.
This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
......@@ -265,7 +273,8 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
......@@ -294,4 +303,4 @@ paths:
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
\ No newline at end of file
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