diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/offeredapis/api_hub/swagger.json | 14 | ||||
| -rw-r--r-- | docs/offeredapis/api_hub/swagger.yaml | 21 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceCatalog/swagger.json | 8 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceCatalog/swagger.yaml | 55 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceInventory/swagger.json | 8 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceInventory/swagger.yaml | 13 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceOrder/swagger.json | 12 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceOrder/swagger.yaml | 19 | ||||
| -rw-r--r-- | docs/offeredapis/api_status/swagger.json | 20 | ||||
| -rw-r--r-- | docs/offeredapis/api_status/swagger.yaml | 21 |
10 files changed, 113 insertions, 78 deletions
diff --git a/docs/offeredapis/api_hub/swagger.json b/docs/offeredapis/api_hub/swagger.json index 66d18a4..b3a1fde 100644 --- a/docs/offeredapis/api_hub/swagger.json +++ b/docs/offeredapis/api_hub/swagger.json @@ -3,7 +3,7 @@ "swagger": "2.0", "info": { "description": "Provides the ability to subscribe to and unsubscribe from External API notifications.\n\n**Main operation**\n\n```\nPOST /hub\n```\n\nrequest sample 1\n\n```\n{\n \"callback\": \"http://mydomain/notification\",\n \"query\": \"eventType = ServiceOrderCreationNotification\"\n}\n```\n\nrequest sample 2\n\n```\n{\n \"callback\": \"http://mydomain/notification\",\n \"query\": \"eventType=ServiceOrderCreationNotification,ServiceOrderStateChangeNotification\"\n}\n```\n\n**EventType for serviceOrdering**\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\n**EventType for serviceInventory**\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n- ServiceRemoveNotification\n\n", - "version": "4.0.1", + "version": "4.1.0", "title": "Hub API", "contact": { "name": "ONAP", @@ -38,6 +38,10 @@ } ], "paths": { + "x-interface": { + "api-version": "4.1.0", + "last-mod-release": "Frankfurt" + }, "/hub": { "post": { "tags": [ @@ -165,7 +169,7 @@ "ErrorDetail": { - "description": "", + "description": "Error code and message", "required": [ @@ -197,7 +201,7 @@ }, "Error": { - "description": "", + "description": "Error code and message", "required": [ @@ -236,7 +240,7 @@ }, "HubIn": { - "description": "", + "description": "Hub query and callback", "required": [ @@ -259,7 +263,7 @@ }, "Hub": { - "description": "", + "description": "Hub id, query and callback", "required": [ diff --git a/docs/offeredapis/api_hub/swagger.yaml b/docs/offeredapis/api_hub/swagger.yaml index 5ddb5d8..ec55cf8 100644 --- a/docs/offeredapis/api_hub/swagger.yaml +++ b/docs/offeredapis/api_hub/swagger.yaml @@ -22,7 +22,7 @@ info: - ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\ \n**EventType for serviceInventory**\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\ - ServiceRemoveNotification\n\n" - version: "4.0.1" + version: "4.1.0" title: "Hub API" contact: name: "ONAP" @@ -46,6 +46,9 @@ tags: - name: "Hub" description: "provided by NBI" paths: + x-interface: + api-version: "4.1.0" + last-mod-release: "Frankfurt" /hub: post: tags: @@ -66,7 +69,7 @@ paths: schema: $ref: "#/definitions/HubIn" responses: - 201: + "201": description: "Created" schema: $ref: "#/definitions/Hub" @@ -80,7 +83,7 @@ paths: description: "" deprecated: false responses: - 200: + "200": description: "Ok" schema: type: "array" @@ -102,7 +105,7 @@ paths: in: "path" type: "string" responses: - 200: + "200": description: "Ok" schema: $ref: "#/definitions/Hub" @@ -119,11 +122,11 @@ paths: in: "path" type: "string" responses: - 204: + "204": description: "No Content" definitions: ErrorDetail: - description: "" + description: "Error code and message" required: - "code" - "message" @@ -143,7 +146,7 @@ definitions: description: "" type: "string" Error: - description: "" + description: "Error code and description" required: - "code" - "message" @@ -167,7 +170,7 @@ definitions: items: $ref: "#/definitions/ErrorDetail" HubIn: - description: "" + description: "Query and callback" required: - "query" - "callback" @@ -182,7 +185,7 @@ definitions: description: "URL where notification must be send" type: "string" Hub: - description: "" + description: "Hub id, callback and query" required: - "id" - "query" 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" diff --git a/docs/offeredapis/api_serviceInventory/swagger.json b/docs/offeredapis/api_serviceInventory/swagger.json index 47e7610..c3a3bde 100644 --- a/docs/offeredapis/api_serviceInventory/swagger.json +++ b/docs/offeredapis/api_serviceInventory/swagger.json @@ -3,7 +3,7 @@ "swagger": "2.0", "info": { "description": "Query information about instantiated services\n\nList of available subscription for serviceInventory notifications, see /hub resources for more information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n- ServiceRemoveNotification\n\n", - "version": "4.0.1", + "version": "4.1.0", "title": "ServiceInventory API", "contact": { "name": "ONAP", @@ -42,6 +42,10 @@ } ], "paths": { + "x-interface": { + "api-version": "4.1.0", + "last-mod-release": "Frankfurt" + }, "/service": { "get": { "tags": [ @@ -188,7 +192,7 @@ "definitions": { "eventType": { - "description": "", + "description": "The Event Type", "type": "string", "enum": [ diff --git a/docs/offeredapis/api_serviceInventory/swagger.yaml b/docs/offeredapis/api_serviceInventory/swagger.yaml index f783679..5d38da3 100644 --- a/docs/offeredapis/api_serviceInventory/swagger.yaml +++ b/docs/offeredapis/api_serviceInventory/swagger.yaml @@ -17,7 +17,7 @@ info: \ subscription for serviceInventory notifications, see /hub resources for more\ \ information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\ - ServiceRemoveNotification\n\n" - version: "4.0.1" + version: "4.1.0" title: "ServiceInventory API" contact: name: "ONAP" @@ -44,6 +44,9 @@ tags: description: "provided by subscriber, which MUST has been registered by creating\ \ a Hub ressource on NBI" paths: + x-interface: + api-version: "4.1.0" + last-mod-release: "Frankfurt" /service: get: tags: @@ -83,7 +86,7 @@ paths: description: "" type: "string" responses: - 200: + "200": description: "Ok" schema: type: "array" @@ -106,7 +109,7 @@ paths: in: "path" type: "string" responses: - 200: + "200": description: "Ok" schema: $ref: "#/definitions/Service" @@ -130,13 +133,13 @@ paths: schema: $ref: "#/definitions/Notification" responses: - 201: + "201": description: "Created" schema: $ref: "#/definitions/Notification" definitions: eventType: - description: "" + description: "The Event Type" type: "string" enum: - "ServiceCreationNotification" diff --git a/docs/offeredapis/api_serviceOrder/swagger.json b/docs/offeredapis/api_serviceOrder/swagger.json index 6c01155..f20e970 100644 --- a/docs/offeredapis/api_serviceOrder/swagger.json +++ b/docs/offeredapis/api_serviceOrder/swagger.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "description": "Request the instantiation, deletion or modification of a service\n\nA Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describes the operation to be completed on a service (add, delete for example). The service order is triggered from external system such as the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.\n\nList of available subscription for serviceOrdering notifications, see /hub resources for more information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\n", - "version": "4.0.1", + "version": "4.1.0", "title": "ServiceOrder API", "contact": { "name": "ONAP", @@ -39,6 +39,10 @@ } ], "paths": { + "x-interface": { + "api-version": "4.1.0", + "last-mod-release": "Frankfurt" + }, "/serviceOrder": { "post": { "tags": [ @@ -300,7 +304,7 @@ ] }, "EventType": { - "description": "", + "description": "The Event Type", "type": "string", "enum": [ "ServiceOrderCreationNotification", @@ -309,7 +313,7 @@ ] }, "SeverityMessage": { - "description": "", + "description": "Message Severity, either information or error", "type": "string", "enum": [ "information", @@ -317,7 +321,7 @@ ] }, "Error": { - "description": "", + "description": "Error code and reason", "required": [ "code", "reason" diff --git a/docs/offeredapis/api_serviceOrder/swagger.yaml b/docs/offeredapis/api_serviceOrder/swagger.yaml index 0ab06bc..fa8dfeb 100644 --- a/docs/offeredapis/api_serviceOrder/swagger.yaml +++ b/docs/offeredapis/api_serviceOrder/swagger.yaml @@ -22,7 +22,7 @@ info: \ available subscription for serviceOrdering notifications, see /hub resources\ \ for more information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n\ - ServiceOrderItemStateChangeNotification\n\n" - version: "4.0.1" + version: "4.1.0" title: "ServiceOrder API" contact: name: "ONAP" @@ -48,6 +48,9 @@ tags: - name: "Notification" description: "provided by subscribers, which MUST registered by creating a hub resource" paths: + x-interface: + api-version: "4.1.0" + last-mod-release: "Frankfurt" /serviceOrder: post: tags: @@ -87,7 +90,7 @@ paths: description: "" type: "string" responses: - 201: + "201": description: "Created" schema: $ref: "#/definitions/ServiceOrder" @@ -149,7 +152,7 @@ paths: type: "integer" format: "int32" responses: - 200: + "200": description: "Ok" schema: type: "array" @@ -192,7 +195,7 @@ paths: description: "" type: "string" responses: - 200: + "200": description: "Ok" schema: $ref: "#/definitions/ServiceOrder" @@ -248,7 +251,7 @@ paths: description: "" type: "string" responses: - 201: + "201": description: "Created" schema: $ref: "#/definitions/Notification" @@ -281,20 +284,20 @@ definitions: enum: - "reliesOn" EventType: - description: "" + description: "The Type of Event" type: "string" enum: - "ServiceOrderCreationNotification" - "ServiceOrderStateChangeNotification" - "ServiceOrderItemStateChangeNotification" SeverityMessage: - description: "" + description: "Enum for Message, information or error" type: "string" enum: - "information" - "error" Error: - description: "" + description: "Error code and reason" required: - "code" - "reason" diff --git a/docs/offeredapis/api_status/swagger.json b/docs/offeredapis/api_status/swagger.json index 344b684..c2bcd52 100644 --- a/docs/offeredapis/api_status/swagger.json +++ b/docs/offeredapis/api_status/swagger.json @@ -3,7 +3,7 @@ "swagger": "2.0", "info": { "description": "Provides a healthcheck to verify that the NBI component is running fine as a standalone application or can also communicate with other onap modules.\n\n", - "version": "4.0.1", + "version": "4.1.0", "title": "Status API", "contact": { "name": "ONAP", @@ -38,6 +38,10 @@ } ], "paths": { + "x-interface": { + "api-version": "4.1.0", + "last-mod-release": "Frankfurt" + }, "/status": { "get": { "tags": [ @@ -79,7 +83,7 @@ "definitions": { "StatusValue": { - "description": "", + "description": "Status Value", "type": "string", "enum": [ @@ -88,7 +92,7 @@ }, "ComponentsName": { - "description": "", + "description": "Components Name", "type": "string", "enum": [ @@ -99,7 +103,7 @@ }, "ApplicationName": { - "description": "", + "description": "Application Name", "type": "string", "enum": [ @@ -108,7 +112,7 @@ }, "ErrorDetail": { - "description": "", + "description": "Error code, infoURL, description and message", "required": [ @@ -140,7 +144,7 @@ }, "Error": { - "description": "", + "description": "Error code and message", "required": [ @@ -179,7 +183,7 @@ }, "Component": { - "description": "", + "description": "Component", "required": [ @@ -202,7 +206,7 @@ }, "Status": { - "description": "", + "description": "Status", "required": [ diff --git a/docs/offeredapis/api_status/swagger.yaml b/docs/offeredapis/api_status/swagger.yaml index 6d21240..a5c156f 100644 --- a/docs/offeredapis/api_status/swagger.yaml +++ b/docs/offeredapis/api_status/swagger.yaml @@ -16,7 +16,7 @@ info: description: "Provides a healthcheck to verify that the NBI component is running\ \ fine as a standalone application or can also communicate with other onap modules.\n\ \n" - version: "4.0.1" + version: "4.1.0" title: "Status API" contact: name: "ONAP" @@ -40,6 +40,9 @@ tags: - name: "Status" description: "" paths: + x-interface: + api-version: "4.1.0" + last-mod-release: "Frankfurt" /status: get: tags: @@ -66,19 +69,19 @@ paths: type: "boolean" default: false responses: - 200: + "200": description: "Ok" schema: $ref: "#/definitions/Status" definitions: StatusValue: - description: "" + description: "Status Value" type: "string" enum: - "ok" - "ko" ComponentsName: - description: "" + description: "Components Name" type: "string" enum: - "sdc connectivity" @@ -86,12 +89,12 @@ definitions: - "aai connectivity" - "dmaap connectivity" ApplicationName: - description: "" + description: "Application Name" type: "string" enum: - "nbi" ErrorDetail: - description: "" + description: "Error code, inforURL, description and message" required: - "code" - "message" @@ -111,7 +114,7 @@ definitions: description: "" type: "string" Error: - description: "" + description: "Error code and message" required: - "code" - "message" @@ -135,7 +138,7 @@ definitions: items: $ref: "#/definitions/ErrorDetail" Component: - description: "" + description: "Component" required: - "name" - "status" @@ -146,7 +149,7 @@ definitions: status: $ref: "#/definitions/StatusValue" Status: - description: "" + description: "Status" required: - "name" - "status" |