From e2704a700197aa439b3580fc2d49962cf0f762a4 Mon Sep 17 00:00:00 2001 From: moscatelli Date: Tue, 7 May 2019 17:08:54 +0200 Subject: [PATCH] SOL002: VNF Configuration interface consolidation --- .../VNFConfiguration/VNFConfiguration.yaml | 104 ++++++++++++------ 1 file changed, 73 insertions(+), 31 deletions(-) diff --git a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml index 18bcb6da..3acb11eb 100644 --- a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml +++ b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml @@ -14,17 +14,23 @@ info: url: https://forge.etsi.org/etsi-forge-copyright-notice.txt contact: name: "NFV-SOL WG" + externalDocs: description: ETSI GS NFV-SOL 002 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf + basePath: /vnfconfig/v1 + schemes: - http - https + - consumes: - application/json + - produces: - application/json + paths: ############################################################################### # API Versions # @@ -43,6 +49,13 @@ paths: in: header required: true type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + type: string get: summary: Read VNF/VNFC configuration from VNF description: > @@ -50,7 +63,7 @@ paths: responses: 200: description: > - OK + 200 OK Configuration information about a VNF instance was read successfully. The response body shall contain a representation of the configuration resource. schema: @@ -66,21 +79,38 @@ paths: type: string maximum: 1 minimum: 1 - 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $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' } - 409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' } - 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } - 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } - 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } - 429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' } - 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } - 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - 504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' } + WWW-Authenticate: + 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. + type: string + maximum: 1 + minimum: 0 + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + 401: + $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/404" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" patch: summary: Modify VNF/VNFC configuration. description: This method sets or modifies a configuration resource. @@ -96,7 +126,7 @@ paths: responses: 200: description: > - OK + 200 OK The request was accepted and completed. The response body shall contain the parameters of the configuration modification that was applied to the configuration resource. @@ -113,17 +143,29 @@ paths: type: string maximum: 1 minimum: 1 - 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $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' } - 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } - 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } - 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } - 429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' } - 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 + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + 401: + $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/404" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 412: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" + 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 -- GitLab