From 2ebe57db71ea6515ad86cf9264864278143e4fcd Mon Sep 17 00:00:00 2001 From: aosull01 Date: Tue, 14 Jan 2020 07:38:31 +0000 Subject: update swagger based on spectral scans Issue-ID: EXTAPI-378 Signed-off-by: aosull01 Change-Id: I3f9b27f67e19f25d92a1383a398a817ab51e8358 --- docs/offeredapis/api_serviceCatalog/swagger.json | 8 +++- docs/offeredapis/api_serviceCatalog/swagger.yaml | 55 +++++++++++++----------- 2 files changed, 35 insertions(+), 28 deletions(-) (limited to 'docs/offeredapis/api_serviceCatalog') diff --git a/docs/offeredapis/api_serviceCatalog/swagger.json b/docs/offeredapis/api_serviceCatalog/swagger.json index 41066c3..f747776 100644 --- a/docs/offeredapis/api_serviceCatalog/swagger.json +++ b/docs/offeredapis/api_serviceCatalog/swagger.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "description": "ServiceCatalog API to retrieve Service Specifications that are available from ONAP.\nThis API is build from TMF open API version 17.5. \nOnly operation GET (by id & byList) for serviceSpecification resource is available.\n To view this swagger file import it into https://editor.swagger.io/ \n\n", - "version": "4.0.1", + "version": "4.1.0", "title": "ServiceCatalog API", "contact": { "name": "ONAP", @@ -37,6 +37,10 @@ } ], "paths": { + "x-interface": { + "api-version": "4.1.0", + "last-mod-release": "Frankfurt" + }, "/serviceSpecification": { "get": { "tags": [ @@ -768,7 +772,7 @@ }, "TargetServiceSchemaRef": { - "description": "", + "description": "Target Service Schema", "required": [ diff --git a/docs/offeredapis/api_serviceCatalog/swagger.yaml b/docs/offeredapis/api_serviceCatalog/swagger.yaml index b0716cb..0425585 100644 --- a/docs/offeredapis/api_serviceCatalog/swagger.yaml +++ b/docs/offeredapis/api_serviceCatalog/swagger.yaml @@ -17,7 +17,7 @@ info: \ build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource\ \ serviceSpecification is available\n \ \ To view this swagger file import it into https://editor.swagger.io/ \n" - version: "4.0.1" + version: "4.1.0" title: "ServiceCatalog API" contact: name: "ONAP" @@ -41,6 +41,9 @@ tags: - name: "ServiceSpecification" description: "" paths: + x-interface: + api-version: "4.1.0" + last-mod-release: "Frankfurt" /serviceSpecification: get: tags: @@ -71,13 +74,13 @@ paths: description: "Service distribution status (filter)" type: "string" responses: - 200: + "200": description: "Ok" schema: type: "array" items: $ref: "#/definitions/ServiceSpecification" - 400: + "400": description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ @@ -85,32 +88,32 @@ paths: \ parameter value" schema: $ref: "#/definitions/ErrorRepresentation" - 401: + "401": description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" schema: $ref: "#/definitions/ErrorRepresentation" - 403: + "403": description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ \ requests" schema: $ref: "#/definitions/ErrorRepresentation" - 404: + "404": description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ \ not found" schema: $ref: "#/definitions/ErrorRepresentation" - 422: + "422": description: "Unprocessable entity\n\nFunctional error" schema: $ref: "#/definitions/ErrorRepresentation" - 500: + "500": description: "Internal Server Error\n\nList of supported error codes:\n\ - 1: Internal error" schema: $ref: "#/definitions/ErrorRepresentation" - 503: + "503": description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ \ retry later !" @@ -138,11 +141,11 @@ paths: description: "Attribute selection" type: "string" responses: - 200: + "200": description: "Ok" schema: $ref: "#/definitions/ServiceSpecification" - 400: + "400": description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ @@ -150,32 +153,32 @@ paths: \ parameter value" schema: $ref: "#/definitions/ErrorRepresentation" - 401: + "401": description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" schema: $ref: "#/definitions/ErrorRepresentation" - 403: + "403": description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ \ requests" schema: $ref: "#/definitions/ErrorRepresentation" - 404: + "404": description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ \ not found" schema: $ref: "#/definitions/ErrorRepresentation" - 422: + "422": description: "Unprocessable entity\n\nFunctional error" schema: $ref: "#/definitions/ErrorRepresentation" - 500: + "500": description: "Internal Server Error\n\nList of supported error codes:\n\ - 1: Internal error" schema: $ref: "#/definitions/ErrorRepresentation" - 503: + "503": description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ \ retry later !" @@ -203,11 +206,11 @@ paths: description: "Attribute selection" type: "string" responses: - 200: + "200": description: "Ok" schema: $ref: "#/definitions/SpecificationInputSchema" - 400: + "400": description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ @@ -215,32 +218,32 @@ paths: \ parameter value" schema: $ref: "#/definitions/ErrorRepresentation" - 401: + "401": description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" schema: $ref: "#/definitions/ErrorRepresentation" - 403: + "403": description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ \ requests" schema: $ref: "#/definitions/ErrorRepresentation" - 404: + "404": description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ \ not found" schema: $ref: "#/definitions/ErrorRepresentation" - 422: + "422": description: "Unprocessable entity\n\nFunctional error" schema: $ref: "#/definitions/ErrorRepresentation" - 500: + "500": description: "Internal Server Error\n\nList of supported error codes:\n\ - 1: Internal error" schema: $ref: "#/definitions/ErrorRepresentation" - 503: + "503": description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ \ retry later !" @@ -583,7 +586,7 @@ definitions: \ for the resource" type: "string" TargetServiceSchemaRef: - description: "" + description: "Target Service Schema" required: - "@type" - "@schemaLocation" -- cgit 1.2.3-korg