From 1221d34fd7ff9f47deb81bcb854fbb25f23438f7 Mon Sep 17 00:00:00 2001 From: Giacomo Bernini Date: Tue, 26 Mar 2019 19:04:02 +0100 Subject: [PATCH] Added main SOL002 API version --- src/SOL002/APIVersion/APIVersion.yaml | 78 +++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 src/SOL002/APIVersion/APIVersion.yaml diff --git a/src/SOL002/APIVersion/APIVersion.yaml b/src/SOL002/APIVersion/APIVersion.yaml new file mode 100644 index 00000000..19e20c81 --- /dev/null +++ b/src/SOL002/APIVersion/APIVersion.yaml @@ -0,0 +1,78 @@ +swagger: "2.0" +info: + version: "1.2.0" + title: "SOL002 - API version interface" + description: > + SOL002 - API version Interface + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to and has not been + approved by the ETSI NFV ISG. In case of discrepancies the published ETSI + Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + license: + name: "ETSI Forge copyright notice" + 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: /{apiName} +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json +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: > + 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/SOL002SOL003_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/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' } -- GitLab