"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",
- "title": "API Hub",
+ "title": "Hub 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": "api.orange.com",
- "basePath": "/",
+ "host": "serverRoot:30274",
+ "basePath": "/nbi/api/v4",
"schemes": [
"http"
],
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "hubCreate",
+ "operationId": "hub_Create",
"summary": "create hub",
"description": "",
"deprecated": false,
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "hubFind",
+ "operationId": "hub_Find",
"summary": "find hub",
"description": "",
"deprecated": false,
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "hubGet",
+ "operationId": "hub_Get",
"summary": "get hub",
"description": "",
"deprecated": false,
"tags": [
"Hub"
],
- "operationId": "hubDelete",
+ "operationId": "hub_Delete",
"summary": "delete hub",
"description": "",
"deprecated": false,
\n**EventType for serviceInventory**\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\
- ServiceRemoveNotification\n\n"
version: "4.0.1"
- title: "API Hub"
+ title: "Hub 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: "api.orange.com"
-basePath: "/"
+host: "serverRoot:30274"
+basePath: "/nbi/api/v4"
schemes:
- "http"
produces:
- "application/json;charset=utf-8"
produces:
- "application/json;charset=utf-8"
- operationId: "hubCreate"
+ operationId: "hub_Create"
summary: "create hub"
description: ""
deprecated: false
- "Hub"
produces:
- "application/json;charset=utf-8"
- operationId: "hubFind"
+ operationId: "hub_Find"
summary: "find hub"
description: ""
deprecated: false
- "Hub"
produces:
- "application/json;charset=utf-8"
- operationId: "hubGet"
+ operationId: "hub_Get"
summary: "get hub"
description: ""
deprecated: false
delete:
tags:
- "Hub"
- operationId: "hubDelete"
+ operationId: "hub_Delete"
summary: "delete hub"
description: ""
deprecated: false
"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"
"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,
"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,
"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,
\ 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"
- "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)\
- "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."
- "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
{
"swagger": "2.0",
"info": {
- "description": "Request the instantiation 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 describe the operation to be done on a service (add, terminate for example). The service order is triggered from 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",
+ "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",
- "title": "API ServiceOrder",
+ "title": "ServiceOrder 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"
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "serviceOrderCreate",
+ "operationId": "serviceOrder_Create",
"summary": "Create a service order",
"description": "This operation creates a service order entity.\nThe TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values.\nPOST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.\n\nIn Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created.\n\nIn Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC.\nDepending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API.",
"deprecated": false,
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "serviceOrderFind",
+ "operationId": "serviceOrder_Find",
"summary": "List service orders",
"description": "Retrieve and list service order entities according to given criteria.\nOnly a predefined set of attribute is proposed.\nAttribute selection could be described in the fields attribute.",
"deprecated": false,
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "serviceOrderGet",
+ "operationId": "serviceOrder_Get",
"summary": "Retrieve a service order",
"description": "This operation retrieves a service order entity. \nAttribute selection is enabled for all first level attributes.",
"deprecated": false,
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "notificationCreate",
+ "operationId": "notification_Create",
"summary": "NBI will send notification to this operation provided by subscribers",
"description": "Notification structure depends of the eventType:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n\n```\n{\n \"eventId\": \"string\",\n \"eventDate\": \"2019-03-12T16:21:27.530Z\",\n \"eventType\": \"string\",\n \"event\": {\n \"id\": \"string\",\n \"href\": \"string\",\n \"externalId\": \"string\",\n \"state\": \"acknowledged\",\n \"orderDate\": \"2019-03-12T16:21:27.530Z\",\n \"completionDateTime\": \"2019-03-12T16:21:27.530Z\"\n }\n}\n```\n\n- ServiceOrderItemStateChangeNotification\n\n```\n{\n \"eventId\": \"string\",\n \"eventDate\": \"2019-03-12T16:21:44.066Z\",\n \"eventType\": \"string\",\n \"event\": {\n \"id\": \"string\",\n \"href\": \"string\",\n \"externalId\": \"string\",\n \"state\": \"acknowledged\",\n \"orderDate\": \"2019-03-12T16:21:44.066Z\",\n \"completionDateTime\": \"2019-03-12T16:21:44.066Z\",\n \"orderItem\": [\n {\n \"id\": \"string\",\n \"action\": \"add\",\n \"state\": \"acknowledged\",\n \"service\": {\n \"id\": \"string\",\n \"href\": \"string\",\n \"name\": \"string\",\n \"serviceState\": \"string\",\n \"serviceCharacteristic\": [\n {\n \"name\": \"string\",\n \"valueType\": \"string\",\n \"value\": {\n \"serviceCharacteristicValue\": \"string\"\n }\n }\n ],\n \"serviceRelationship\": [\n {\n \"type\": \"reliesOn\"\n }\n ],\n \"relatedParty\": [\n {\n \"id\": \"string\",\n \"href\": \"string\",\n \"role\": \"string\",\n \"name\": \"string\",\n \"@referredType\": \"string\"\n }\n ],\n \"serviceSpecification\": {\n \"id\": \"string\",\n \"href\": \"string\",\n \"name\": \"string\",\n \"version\": \"string\",\n }\n }\n }\n ]\n }\n}\n```",
"deprecated": false,
# limitations under the License.swagger: "2.0"
swagger: "2.0"
info:
- description: "Request the instantiation of a service\n\nA Service Order is a type\
+ 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 describe the operation to be done on a service (add, terminate for example).\
- \ The service order is triggered from the BSS system in charge of the product\
+ \ item describe the operation to be done 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"
- title: "API ServiceOrder"
+ title: "ServiceOrder 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"
- "application/json;charset=utf-8"
produces:
- "application/json;charset=utf-8"
- operationId: "serviceOrderCreate"
+ operationId: "serviceOrder_Create"
summary: "Create a service order"
description: "This operation creates a service order entity.\nThe TMF Open API\
\ specification document provides the list of mandatory and non mandatory\
- "ServiceOrder"
produces:
- "application/json;charset=utf-8"
- operationId: "serviceOrderFind"
+ operationId: "serviceOrder_Find"
summary: "List service orders"
description: "Retrieve and list service order entities according to given criteria.\n\
Only a predefined set of attribute is proposed.\nAttribute selection could\
- "ServiceOrder"
produces:
- "application/json;charset=utf-8"
- operationId: "serviceOrderGet"
+ operationId: "serviceOrder_Get"
summary: "Retrieve a service order"
description: "This operation retrieves a service order entity. \nAttribute selection\
\ is enabled for all first level attributes."
- "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: "Notification structure depends of the eventType:\n\n- ServiceOrderCreationNotification\n\
- ServiceOrderStateChangeNotification\n\n```\n{\n \"eventId\": \"string\"\
"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",
- "title": "API Status",
+ "title": "Status 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",
- "basePath": "/nbi/api/v4",
+ "host": "serverRoot:30274",
+ "basePath":"/nbi/api/v4",
"schemes": [
"http"
],
"produces": [
"application/json;charset=utf-8"
],
- "operationId": "statusFind",
+ "operationId": "status_Find",
"summary": "retrieve application status",
"description": "* Default\n\n```\n{\n \"name\": \"nbi\",\n \"status\": \"ok\",\n \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n```\n\n```\n{\n \"name\": \"nbi\",\n \"status\": \"ok\",\n \"version\": \"v3\",\n \"components\": [\n {\n \"name\": \"sdc connectivity\",\n \"status\": \"ko\"\n },\n {\n \"name\": \"so connectivity\",\n \"status\": \"ok\"\n },\n {\n \"name\": \"aai connectivity\",\n \"status\": \"ok\"\n },\n {\n \"name\": \"dmaap connectivity\",\n \"status\": \"ok\"\n }\n ]\n}\n```",
"deprecated": false,
\ fine as a standalone application or can also communicate with other onap modules.\n\
\n"
version: "4.0.1"
- title: "API Status"
+ title: "Status 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"
- "Status"
produces:
- "application/json;charset=utf-8"
- operationId: "statusFind"
+ operationId: "status_Find"
summary: "retrieve application status"
description: "* Default\n\n```\n{\n \"name\": \"nbi\",\n \"status\": \"\
ok\",\n \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n\
Code Review / externalapi / nbi.git / commitdiff