aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/api_hub
diff options
context:
space:
mode:
authoraosull01 <adrian.osullivan@huawei.com>2020-01-14 07:38:31 +0000
committeraosull01 <adrian.osullivan@huawei.com>2020-01-14 07:38:31 +0000
commit2ebe57db71ea6515ad86cf9264864278143e4fcd (patch)
tree2786e153a19a55442067d655dd06c1e93fd517bd /docs/offeredapis/api_hub
parent74474544e4e3013c582ca5579a0088c40dacc0e5 (diff)
update swagger based on spectral scans
Issue-ID: EXTAPI-378 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I3f9b27f67e19f25d92a1383a398a817ab51e8358
Diffstat (limited to 'docs/offeredapis/api_hub')
-rw-r--r--docs/offeredapis/api_hub/swagger.json14
-rw-r--r--docs/offeredapis/api_hub/swagger.yaml21
2 files changed, 21 insertions, 14 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"