From d11510b3172ae9ec7a8d5811b45303beb5cf957d Mon Sep 17 00:00:00 2001 From: moscatelli Date: Thu, 9 May 2019 10:21:58 +0200 Subject: [PATCH] SOL005: unique notification endpoint for NSD mgmt and NS performance mgmt interfaces + fixes in response type descriptions --- src/SOL005/NSDManagement/NSDManagement.yaml | 87 ++++++++++++++++++++- 1 file changed, 85 insertions(+), 2 deletions(-) diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index e75e067..ff4ce63 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -15,17 +15,23 @@ info: url: https://forge.etsi.org/etsi-forge-copyright-notice.txt contact: name: "NFV-SOL WG" + externalDocs: description: ETSI GS NFV-SOL 005 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf + basePath: /nsd/v1 + schemes: - http - https + consumes: - application/json + produces: - application/json + paths: ############################################################################### # API Versions # @@ -408,6 +414,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to an operational state mismatch, i.e. enable an already enabled or disable an already disabled individual NS descriptor resource, or the "nsdOnboardingState" is not ONBOARDED. @@ -445,7 +453,7 @@ paths: responses: 204: description: > - 204 No Content + 204 NO CONTENT The operation has completed successfully. The response body shall be empty. @@ -478,6 +486,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact the NS descriptor resource is in the enabled operational state (i.e. operationalState = ENABLED) or there are running NS instances using the concerned individual @@ -589,6 +599,8 @@ paths: minimum: 1 206: description: > + 206 PARTIAL CONTENT + On success, if the NFVO supports range requests, a single consecutive byte range from the content of the NSD file is returned. The response body shall contain the requested part of the NSD file. @@ -609,6 +621,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact "nsdOnboardingState" has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall @@ -616,6 +630,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: description: > + 416 RANGE NOT SATISFIABLE + The byte range passed in the "Range" header did not match any available byte range in the NSD file (e.g. "access after end of file"). The response body may contain a ProblemDetails structure. @@ -694,6 +710,21 @@ paths: The NSD content was successfully uploaded and validated (synchronous mode). The response body shall be empty. + headers: + WWW-Authenticate: + type: string + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -708,6 +739,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the NsdOnboardingState has a value other than CREATED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall @@ -1116,6 +1149,21 @@ paths: The operation has completed successfully. The response body shall be empty. + headers: + WWW-Authenticate: + type: string + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1217,6 +1265,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > + 409 CONFLICT + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact pnfdOnboardingState has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute @@ -1249,6 +1299,21 @@ paths: The PNFD content was successfully uploaded and validated. The response body shall be empty. + headers: + WWW-Authenticate: + type: string + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1263,8 +1328,9 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > - Error: The operation cannot be executed currently, due to a conflict with the state of the resource. + 409 CONFLICT + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the PnfdOnboardingState has a value other than CREATED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. @@ -1370,6 +1436,8 @@ paths: minimum: 1 303: description: > + 303 SEE OTHER + A subscription with the same callbackURI and the same filter already exits 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 @@ -1617,6 +1685,21 @@ paths: The subscription resource was deleted successfully. The response body shall be empty. + headers: + WWW-Authenticate: + type: string + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: -- GitLab