From ca20793652dc0df6c25cdde9e2bbe007c0efebbe Mon Sep 17 00:00:00 2001 From: aosull01 Date: Fri, 28 Feb 2020 17:58:55 +0000 Subject: Add index html and update remaining swagger for NBI Issue-ID: EXTAPI-402 Signed-off-by: aosull01 Change-Id: I5746fd31f14c106bb85983af987ef0e71910e20d --- docs/offeredapis/api_hub/index.html | 344 +++++++++++++++++++++++++++++++++ docs/offeredapis/api_hub/onap_logo.png | Bin 0 -> 6706 bytes 2 files changed, 344 insertions(+) create mode 100644 docs/offeredapis/api_hub/index.html create mode 100644 docs/offeredapis/api_hub/onap_logo.png (limited to 'docs/offeredapis/api_hub') diff --git a/docs/offeredapis/api_hub/index.html b/docs/offeredapis/api_hub/index.html new file mode 100644 index 0000000..d6ef01d --- /dev/null +++ b/docs/offeredapis/api_hub/index.html @@ -0,0 +1,344 @@ + + + + + + Hub API + + + + + + + + + +
logo
Documentation Powered by ReDoc

Hub API (4.1.0)

Download OpenAPI specification:Download

ONAP: onap-discuss@lists.onap.org URL: https://onap.readthedocs.io License: Apache 2.0

Provides the ability to subscribe to and unsubscribe from External API notifications.

+

Main operation

+
POST /hub

request sample 1

+
{
+  "callback": "http://mydomain/notification",
+  "query": "eventType = ServiceOrderCreationNotification"
+}

request sample 2

+
{
+  "callback": "http://mydomain/notification",
+  "query": "eventType=ServiceOrderCreationNotification,ServiceOrderStateChangeNotification"
+}

EventType for serviceOrdering

+
    +
  • ServiceOrderCreationNotification
    • +
  • ServiceOrderStateChangeNotification
    • +
  • ServiceOrderItemStateChangeNotification
    • +
+

EventType for serviceInventory

+
    +
  • ServiceCreationNotification
    • +
  • ServiceAttributeValueChangeNotification
    • +
  • ServiceRemoveNotification
    • +
+

Hub

provided by NBI

+

create hub

Request Body schema: application/json;charset=utf-8
query
required
string

The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED

+
callback
required
string

URL where notification must be send

+

Responses

201

Created

+
post /hub
http://serverRoot:30274/nbi/api/v4/hub
https://serverRoot:30274/nbi/api/v4/hub

Request samples

Content type
application/json;charset=utf-8
Copy
 Expand all Collapse all
{
  • "query": "string",
  • "callback": "string"
}

Response samples

Content type
application/json;charset=utf-8
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "query": "string",
  • "callback": "string"
}

find hub

Responses

200

Ok

+
get /hub
http://serverRoot:30274/nbi/api/v4/hub
https://serverRoot:30274/nbi/api/v4/hub

Response samples

Content type
application/json;charset=utf-8
Copy
 Expand all Collapse all
[
  • {
    }
]

get hub

path Parameters
hubId
required
string

Responses

200

Ok

+
get /hub/{hubId}
http://serverRoot:30274/nbi/api/v4/hub/{hubId}
https://serverRoot:30274/nbi/api/v4/hub/{hubId}

Response samples

Content type
application/json;charset=utf-8
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "query": "string",
  • "callback": "string"
}

delete hub

path Parameters
hubId
required
string

Responses

204

No Content

+
delete /hub/{hubId}
http://serverRoot:30274/nbi/api/v4/hub/{hubId}
https://serverRoot:30274/nbi/api/v4/hub/{hubId}
+ + + + diff --git a/docs/offeredapis/api_hub/onap_logo.png b/docs/offeredapis/api_hub/onap_logo.png new file mode 100644 index 0000000..796e1bd Binary files /dev/null and b/docs/offeredapis/api_hub/onap_logo.png differ -- cgit 1.2.3-korg