aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/api_serviceInventory
diff options
context:
space:
mode:
authoraosull01 <adrian.osullivan@huawei.com>2020-01-07 12:28:11 +0000
committeraosull01 <adrian.osullivan@huawei.com>2020-01-07 12:28:11 +0000
commitdf23184a2288013d954392d3f5e59787aeca41bc (patch)
treee52939d1d428de53f87b1f5c36d197f5dda6e679 /docs/offeredapis/api_serviceInventory
parentc1ae66b947edefe90ffb9c788db1ee75779b0624 (diff)
Update other swaggers as per guidelines
Issue-ID: EXTAPI-357 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I906f81722074c9a679ac6048e544e884646ed760
Diffstat (limited to 'docs/offeredapis/api_serviceInventory')
-rw-r--r--docs/offeredapis/api_serviceInventory/swagger.json21
-rw-r--r--docs/offeredapis/api_serviceInventory/swagger.yaml19
2 files changed, 30 insertions, 10 deletions
diff --git a/docs/offeredapis/api_serviceInventory/swagger.json b/docs/offeredapis/api_serviceInventory/swagger.json
index f67e1b6..47e7610 100644
--- a/docs/offeredapis/api_serviceInventory/swagger.json
+++ b/docs/offeredapis/api_serviceInventory/swagger.json
@@ -4,14 +4,25 @@
"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",
- "title": "API ServiceInventory",
+ "title": "ServiceInventory API",
+ "contact": {
+ "name": "ONAP",
+ "url": "https://onap.readthedocs.io",
+ "email": "onap-discuss@lists.onap.org"
+ },
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ },
+ "x-planned-retirement-date": "205001",
+ "x-component": "NBI",
"x-logo": {
"url": "/redoc/logo.png",
"backgroundColor": "#FFFFFF"
}
},
- "host": "localhost:8080",
+ "host": "serverRoot:30274",
"basePath": "/nbi/api/v4",
"schemes": [
"http"
@@ -39,7 +50,7 @@
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "serviceFind",
+ "operationId": "service_Find",
"summary": "List services",
"description": "This operation list service entities. \nAttribute selection is restricted. \nfields attribute may be used to filter retrieved attribute(s) for each service",
"deprecated": false,
@@ -109,7 +120,7 @@
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "serviceGet",
+ "operationId": "service_Get",
"summary": "Retrieve a service",
"description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.",
"deprecated": false,
@@ -145,7 +156,7 @@
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "notificationCreate",
+ "operationId": "notification_Create",
"summary": "NBI will send notification to this operation provided by subscribers",
"description": "",
"deprecated": false,
diff --git a/docs/offeredapis/api_serviceInventory/swagger.yaml b/docs/offeredapis/api_serviceInventory/swagger.yaml
index 8f2ebee..f783679 100644
--- a/docs/offeredapis/api_serviceInventory/swagger.yaml
+++ b/docs/offeredapis/api_serviceInventory/swagger.yaml
@@ -18,11 +18,20 @@ info:
\ information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\
- ServiceRemoveNotification\n\n"
version: "4.0.1"
- title: "API ServiceInventory"
+ title: "ServiceInventory API"
+ contact:
+ name: "ONAP"
+ url: "https://onap.readthedocs.io"
+ email: "onap-discuss@lists.onap.org"
+ license:
+ name: "Apache 2.0"
+ url: "http://www.apache.org/licenses/LICENSE-2.0"
+ x-planned-retirement-date: "205001"
+ x-component: "NBI"
x-logo:
url: "/redoc/logo.png"
backgroundColor: "#FFFFFF"
-host: "localhost:8080"
+host: "serverRoot:30274"
basePath: "/nbi/api/v4"
schemes:
- "http"
@@ -41,7 +50,7 @@ paths:
- "Service"
produces:
- "application/json;charset=utf-8"
- operationId: "serviceFind"
+ operationId: "service_Find"
summary: "List services"
description: "This operation list service entities. \nAttribute selection is\
\ restricted. \nfields attribute may be used to filter retrieved attribute(s)\
@@ -86,7 +95,7 @@ paths:
- "Service"
produces:
- "application/json;charset=utf-8"
- operationId: "serviceGet"
+ operationId: "service_Get"
summary: "Retrieve a service"
description: "This operation retrieves a service entity. \nAttribute selection\
\ is enabled for all first level attributes."
@@ -109,7 +118,7 @@ paths:
- "application/json;charset=utf-8"
produces:
- "application/json;charset=utf-8"
- operationId: "notificationCreate"
+ operationId: "notification_Create"
summary: "NBI will send notification to this operation provided by subscribers"
description: ""
deprecated: false