Commit 8df3a1e4 authored by moscatelli's avatar moscatelli
Browse files

SOL003: general consolidation of responses codes

parent ed669390
Pipeline #1213 passed with stage
in 0 seconds
......@@ -40,7 +40,7 @@ produces:
paths:
###############################################################################
# Notification endpoint VnfLcmOperationOccurrenceNotification #
# Notification endpoint VnfLcmOperationOccurrenceNotification #
###############################################################################
'/URI-is-provided-by-the-client-when-creating-the-subscription-VnfLcmOperationOccurrenceNotification':
post:
......@@ -138,7 +138,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: >
......@@ -269,7 +270,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: >
......@@ -400,7 +402,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: >
......
swagger: "2.0"
info:
version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL003 - VNF Package Management Notification interface
description: >
SOL003 - VNF Package Management Notification interface
......@@ -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"
......@@ -46,10 +46,11 @@ paths:
#SOL003 location: 10.4.9
post:
description: >
Notify
The POST method delivers a notification from the server to the client.
Notify.
The POST method delivers a notification from the 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 10.4.9.3.1-1 and 10.4.9.3.1-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: VnfPackageOnboardingNotification
description: A notification about on-boarding of a VNF package.
......@@ -82,7 +83,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: >
......@@ -104,8 +105,8 @@ 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"
500:
......@@ -114,8 +115,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 10.4.9.3.2-1 and 10.4.9.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
......@@ -135,7 +138,7 @@ 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:
......@@ -158,14 +161,15 @@ 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"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Notification endpoint VnfPackageChangeNotification #
###############################################################################
......@@ -173,10 +177,11 @@ paths:
#SOL003 location: 10.4.9
post:
description: >
Notify
The POST method delivers a notification from the server to the client.
Notify.
The POST method delivers a notification from the 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 10.4.9.3.1-1 and 10.4.9.3.1-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: VnfPackageChangeNotification
description: >
......@@ -210,7 +215,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: >
......@@ -232,8 +237,8 @@ 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"
500:
......@@ -242,8 +247,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 10.4.9.3.2-1 and 10.4.9.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
......@@ -263,7 +270,7 @@ 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:
......@@ -286,12 +293,11 @@ 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"
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
Markdown is supported
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