From 5051b7714b0dabb0e3c7efd7ffb409cd63de2afd Mon Sep 17 00:00:00 2001 From: moscatelli Date: Mon, 15 Apr 2019 11:54:26 +0200 Subject: [PATCH] SOL005: API versions endpoint included ad endpoint type + API version updated to 1.2.0 + PDF references updated --- src/SOL005/NSDManagement/NSDManagement.yaml | 48 +--------------- .../NSFaultManagement/NSFaultManagement.yaml | 55 ++----------------- .../NSLifecycleManagement.yaml | 55 ++----------------- .../NSPerformanceManagement.yaml | 48 +--------------- .../VNFPackageManagement.yaml | 55 ++----------------- src/SOL005/endpoints/SOL005_endpoints.yaml | 50 +++++++++++++++++ src/SOL005/responses/SOL005_resp.yaml | 4 ++ 7 files changed, 71 insertions(+), 244 deletions(-) create mode 100644 src/SOL005/endpoints/SOL005_endpoints.yaml diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index ce2586a..05c09b7 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -31,53 +31,7 @@ paths: # API Versions # ############################################################################### '/api-versions': - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow the provisions specified in - table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not - supported. - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - type: string - responses: - 200: - description: > - 200 OK - - API version information was read successfully. - The response body shall contain API version information, as defined in clause 4.4.1.7. - schema: - $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' } - 401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' } - 403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' } - 404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' } - 405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' } - 406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' } - 413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' } - 414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' } - 416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' } - 422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' } - 429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' } - 500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' } - 503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' } - 504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' } + $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' ############################################################################### # NS Descriptors # diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index f6db551..c8bc097 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.0.0" + version: "1.2.0" title: SOL005 - NS Fault Management Interface description: > SOL005 - NS Fault Management Interface @@ -16,8 +16,8 @@ info: contact: name: "NFV-SOL WG" externalDocs: - description: ETSI GS NFV-SOL 005 V2.4.1 - url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf + 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: "/nsfm/v1" schemes: - https @@ -30,53 +30,8 @@ paths: # API Versions # ############################################################################### '/api-versions': - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow the provisions specified in - table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not - supported. - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - type: string - responses: - 200: - description: > - 200 OK - - API version information was read successfully. - The response body shall contain API version information, as defined in clause 4.4.1.7. - schema: - $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' } - 401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' } - 403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' } - 404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' } - 405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' } - 406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' } - 413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' } - 414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' } - 416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' } - 422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' } - 429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' } - 500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' } - 503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' } - 504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' } + $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' + ############################################################################### # Alarms # ############################################################################### diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index 759cac3..bfe7e2c 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.0.0" + version: "1.2.0" title: SOL005 - NS Lifecycle Management Interface description: > SOL005 - NS Lifecycle Management Interface @@ -16,8 +16,8 @@ info: contact: name: "NFV-SOL WG" externalDocs: - description: ETSI GS NFV-SOL 005 V2.4.1 - url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf + 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: "/nslcm/v1" schemes: - https @@ -30,53 +30,8 @@ paths: # API Versions # ############################################################################### '/api-versions': - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow the provisions specified in - table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not - supported. - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - type: string - responses: - 200: - description: > - 200 OK - - API version information was read successfully. - The response body shall contain API version information, as defined in clause 4.4.1.7. - schema: - $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' } - 401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' } - 403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' } - 404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' } - 405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' } - 406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' } - 413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' } - 414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' } - 416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' } - 422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' } - 429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' } - 500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' } - 503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' } - 504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' } + $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' + ############################################################################### # NSInstances # ############################################################################### diff --git a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml index 680be71..dd61499 100644 --- a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +++ b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml @@ -31,53 +31,7 @@ paths: # API Versions # ############################################################################### '/api-versions': - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow the provisions specified in - table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not - supported. - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - type: string - responses: - 200: - description: > - 200 OK - - API version information was read successfully. - The response body shall contain API version information, as defined in clause 4.4.1.7. - schema: - $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' } - 401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' } - 403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' } - 404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' } - 405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' } - 406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' } - 413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' } - 414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' } - 416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' } - 422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' } - 429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' } - 500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' } - 503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' } - 504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' } + $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' ############################################################################### # PM Jobs # diff --git a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml index 16c66a9..ca972e7 100644 --- a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.0.0" + version: "1.2.0" title: SOL005 - VNF Package Management Interface description: > SOL005 - VNF Package Management Interface @@ -16,8 +16,8 @@ info: contact: name: "NFV-SOL WG" externalDocs: - description: ETSI GS NFV-SOL 005 V2.4.1 - url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf + 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: "/vnfpkgm/v1" schemes: - https @@ -30,53 +30,8 @@ paths: # API Versions # ############################################################################### '/api-versions': - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow the provisions specified in - table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not - supported. - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - type: string - responses: - 200: - description: > - 200 OK - - API version information was read successfully. - The response body shall contain API version information, as defined in clause 4.4.1.7. - schema: - $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' } - 401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' } - 403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' } - 404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' } - 405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' } - 406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' } - 413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' } - 414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' } - 416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' } - 422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' } - 429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' } - 500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' } - 503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' } - 504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' } + $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' + ############################################################################### # VNF Packages # ############################################################################### diff --git a/src/SOL005/endpoints/SOL005_endpoints.yaml b/src/SOL005/endpoints/SOL005_endpoints.yaml new file mode 100644 index 0000000..b5ee389 --- /dev/null +++ b/src/SOL005/endpoints/SOL005_endpoints.yaml @@ -0,0 +1,50 @@ +# Copyright (c) ETSI 2017. +# https://forge.etsi.org/etsi-forge-copyright-notice.txt +endpoints: + api-versions: + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + get: + summary: Retrieve API version information + description: > + The GET method reads API version information. This method shall follow the provisions specified in + table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not + supported. + responses: + 200: + description: > + API version information was read successfully. + The response body shall contain 4.4 API version + information, as defined in clause 4.4.1.13. + schema: + $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation' + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 + 400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' } + 401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' } + 403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' } + 404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' } + 405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' } + 406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' } + 413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' } + 414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' } + 416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' } + 422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' } + 429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' } + 500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' } + 503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' } + 504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' } \ No newline at end of file diff --git a/src/SOL005/responses/SOL005_resp.yaml b/src/SOL005/responses/SOL005_resp.yaml index ef700cb..5c1258a 100644 --- a/src/SOL005/responses/SOL005_resp.yaml +++ b/src/SOL005/responses/SOL005_resp.yaml @@ -61,6 +61,10 @@ responses: 400: description: > BAD REQUEST + + 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the + "ProblemDetails" structure to be returned. + If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, -- GitLab