diff options
Diffstat (limited to 'docs/offeredapis/api_serviceOrder/swagger.yaml')
| -rw-r--r-- | docs/offeredapis/api_serviceOrder/swagger.yaml | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/docs/offeredapis/api_serviceOrder/swagger.yaml b/docs/offeredapis/api_serviceOrder/swagger.yaml index 2108fc3..0ab06bc 100644 --- a/docs/offeredapis/api_serviceOrder/swagger.yaml +++ b/docs/offeredapis/api_serviceOrder/swagger.yaml @@ -13,21 +13,30 @@ # 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" @@ -47,7 +56,7 @@ paths: - "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\ @@ -87,7 +96,7 @@ paths: - "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\ @@ -161,7 +170,7 @@ paths: - "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." @@ -195,7 +204,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: "Notification structure depends of the eventType:\n\n- ServiceOrderCreationNotification\n\ - ServiceOrderStateChangeNotification\n\n```\n{\n \"eventId\": \"string\"\ |