diff options
Diffstat (limited to 'docs/offeredapis/api_hub')
| -rw-r--r-- | docs/offeredapis/api_hub/api.plantuml | 30 | ||||
| -rw-r--r-- | docs/offeredapis/api_hub/model.xsd | 83 | ||||
| -rw-r--r-- | docs/offeredapis/api_hub/swagger.json | 279 | ||||
| -rw-r--r-- | docs/offeredapis/api_hub/swagger.yaml | 180 |
4 files changed, 572 insertions, 0 deletions
diff --git a/docs/offeredapis/api_hub/api.plantuml b/docs/offeredapis/api_hub/api.plantuml new file mode 100644 index 0000000..0b0016c --- /dev/null +++ b/docs/offeredapis/api_hub/api.plantuml @@ -0,0 +1,30 @@ +@startuml + + +class ErrorDetail { + code:int + message:string + description:string + infoURL:string +} + +class Error { + code:int + message:string + description:string + infoURL:string +} + Error --> "0-*" ErrorDetail : details + +class HubIn { + query:string + callback:string +} + +class Hub { + id:string + query:string + callback:string +} + +@enduml
\ No newline at end of file diff --git a/docs/offeredapis/api_hub/model.xsd b/docs/offeredapis/api_hub/model.xsd new file mode 100644 index 0000000..09f4500 --- /dev/null +++ b/docs/offeredapis/api_hub/model.xsd @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xs:schema xmlns:xmime="http://www.w3.org/2005/05/xmlmime" + xmlns="http://orange.com/ONAPNBI/api/hub/v4/model" + xmlns:xs="http://www.w3.org/2001/XMLSchema" + attributeFormDefault="unqualified" + elementFormDefault="qualified" + targetNamespace="http://orange.com/ONAPNBI/api/hub/v4/model"> + <xs:annotation id="signature"> + <xs:appinfo>API Designer</xs:appinfo> + <xs:documentation>Model: hub + Version: 4.0.0_inProgress + Owner: ONAPNBI + Generated on: 2019-03-12T16:45:33.51Z + Generated by: Orange API Designer v2, model-v1</xs:documentation> + </xs:annotation> + <xs:element name="ErrorDetail" type="ErrorDetail"/> + <xs:complexType name="ErrorDetail"> + <xs:sequence minOccurs="1" maxOccurs="1"> + <xs:element name="code" type="xs:int" minOccurs="1"/> + <xs:element name="message" type="xs:string" minOccurs="1"/> + <xs:element name="description" type="xs:string" minOccurs="0"/> + <xs:element name="infoURL" type="xs:string" minOccurs="0"/> + </xs:sequence> + </xs:complexType> + <xs:element name="Error" type="Error"/> + <xs:complexType name="Error"> + <xs:sequence minOccurs="1" maxOccurs="1"> + <xs:element name="code" type="xs:int" minOccurs="1"/> + <xs:element name="message" type="xs:string" minOccurs="1"/> + <xs:element name="description" type="xs:string" minOccurs="0"/> + <xs:element name="infoURL" type="xs:string" minOccurs="0"/> + <xs:element name="details" + type="ErrorDetail" + minOccurs="0" + maxOccurs="unbounded"/> + </xs:sequence> + </xs:complexType> + <xs:element name="HubIn" type="HubIn"> + <xs:annotation> + <xs:documentation source="public"/> + </xs:annotation> + </xs:element> + <xs:complexType name="HubIn"> + <xs:annotation> + <xs:documentation source="public"/> + </xs:annotation> + <xs:sequence minOccurs="1" maxOccurs="1"> + <xs:element name="query" type="xs:string" minOccurs="1"> + <xs:annotation> + <xs:documentation source="public">The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED</xs:documentation> + </xs:annotation> + </xs:element> + <xs:element name="callback" type="xs:string" minOccurs="1"> + <xs:annotation> + <xs:documentation source="public">URL where notification must be send</xs:documentation> + </xs:annotation> + </xs:element> + </xs:sequence> + </xs:complexType> + <xs:element name="Hub" type="Hub"> + <xs:annotation> + <xs:documentation source="public"/> + </xs:annotation> + </xs:element> + <xs:complexType name="Hub"> + <xs:annotation> + <xs:documentation source="public"/> + </xs:annotation> + <xs:sequence minOccurs="1" maxOccurs="1"> + <xs:element name="id" type="xs:string" minOccurs="1"/> + <xs:element name="query" type="xs:string" minOccurs="1"> + <xs:annotation> + <xs:documentation source="public">The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED</xs:documentation> + </xs:annotation> + </xs:element> + <xs:element name="callback" type="xs:string" minOccurs="1"> + <xs:annotation> + <xs:documentation source="public">URL where notification must be send</xs:documentation> + </xs:annotation> + </xs:element> + </xs:sequence> + </xs:complexType> +</xs:schema> diff --git a/docs/offeredapis/api_hub/swagger.json b/docs/offeredapis/api_hub/swagger.json new file mode 100644 index 0000000..2497dcf --- /dev/null +++ b/docs/offeredapis/api_hub/swagger.json @@ -0,0 +1,279 @@ + + { + "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.0_inProgress", + "title": "API Hub", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "api.orange.com", + "basePath": "/", + "schemes": [ + "http" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "Hub", + "description": "provided by NBI" + } + ], + "paths": { + "/hub": { + "post": { + "tags": [ + "Hub" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "hubCreate", + "summary": "create hub", + "description": "", + "deprecated": false, + + "parameters": [ + + { + "name": "Hub", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/HubIn" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Hub" + } + + } + } + }, + "get": { + "tags": [ + "Hub" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "hubFind", + "summary": "find hub", + "description": "", + "deprecated": false, + + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Hub" + } + } + + } + } + } + }, + "/hub/{hubId}": { + "get": { + "tags": [ + "Hub" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "hubGet", + "summary": "get hub", + "description": "", + "deprecated": false, + + "parameters": [ + + { + "name": "hubId", + "required": true, + "in": "path", + "type" : "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Hub" + } + + } + } + }, + "delete": { + "tags": [ + "Hub" + ], + "operationId": "hubDelete", + "summary": "delete hub", + "description": "", + "deprecated": false, + + "parameters": [ + + { + "name": "hubId", + "required": true, + "in": "path", + "type" : "string" + } + ], + "responses": { + "204": { + "description": "No Content" + + } + } + } + } + }, + "definitions": { + + + "ErrorDetail": { + "description": "", + + + "required": [ + + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "", + "type": "integer", + "format": "int32" + }, + "message": { + "description": "", + "type": "string" + }, + "description": { + "description": "", + "type": "string" + }, + "infoURL": { + "description": "", + "type": "string" + } + } + + }, + + "Error": { + "description": "", + + + "required": [ + + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "", + "type": "integer", + "format": "int32" + }, + "message": { + "description": "", + "type": "string" + }, + "description": { + "description": "", + "type": "string" + }, + "infoURL": { + "description": "", + "type": "string" + }, + "details": { + + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + } + + }, + + "HubIn": { + "description": "", + + + "required": [ + + "query", + "callback" + ], + "type": "object", + "properties": { + "query": { + "description": "The query must have an eventType= information.\\nOptionally a ? could be added to reduce hub.\\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED", + "type": "string" + }, + "callback": { + "description": "URL where notification must be send", + "type": "string" + } + } + + }, + + "Hub": { + "description": "", + + + "required": [ + + "id", + "query", + "callback" + ], + "type": "object", + "properties": { + "id": { + "description": "", + "type": "string" + }, + "query": { + "description": "The query must have an eventType= information.\\nOptionally a ? could be added to reduce hub.\\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED", + "type": "string" + }, + "callback": { + "description": "URL where notification must be send", + "type": "string" + } + } + + } + } + } +
\ No newline at end of file diff --git a/docs/offeredapis/api_hub/swagger.yaml b/docs/offeredapis/api_hub/swagger.yaml new file mode 100644 index 0000000..7c1a6d0 --- /dev/null +++ b/docs/offeredapis/api_hub/swagger.yaml @@ -0,0 +1,180 @@ +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.0_inProgress" + title: "API Hub" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "api.orange.com" +basePath: "/" +schemes: +- "http" +produces: +- "application/json;charset=utf-8" +tags: +- name: "Hub" + description: "provided by NBI" +paths: + /hub: + post: + tags: + - "Hub" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "hubCreate" + summary: "create hub" + description: "" + deprecated: false + parameters: + - name: "Hub" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/HubIn" + responses: + 201: + description: "Created" + schema: + $ref: "#/definitions/Hub" + get: + tags: + - "Hub" + produces: + - "application/json;charset=utf-8" + operationId: "hubFind" + summary: "find hub" + description: "" + deprecated: false + responses: + 200: + description: "Ok" + schema: + type: "array" + items: + $ref: "#/definitions/Hub" + /hub/{hubId}: + get: + tags: + - "Hub" + produces: + - "application/json;charset=utf-8" + operationId: "hubGet" + summary: "get hub" + description: "" + deprecated: false + parameters: + - name: "hubId" + required: true + in: "path" + type: "string" + responses: + 200: + description: "Ok" + schema: + $ref: "#/definitions/Hub" + delete: + tags: + - "Hub" + operationId: "hubDelete" + summary: "delete hub" + description: "" + deprecated: false + parameters: + - name: "hubId" + required: true + in: "path" + type: "string" + responses: + 204: + description: "No Content" +definitions: + ErrorDetail: + description: "" + required: + - "code" + - "message" + type: "object" + properties: + code: + description: "" + type: "integer" + format: "int32" + message: + description: "" + type: "string" + description: + description: "" + type: "string" + infoURL: + description: "" + type: "string" + Error: + description: "" + required: + - "code" + - "message" + type: "object" + properties: + code: + description: "" + type: "integer" + format: "int32" + message: + description: "" + type: "string" + description: + description: "" + type: "string" + infoURL: + description: "" + type: "string" + details: + type: "array" + items: + $ref: "#/definitions/ErrorDetail" + HubIn: + description: "" + required: + - "query" + - "callback" + type: "object" + properties: + query: + description: "The query must have an eventType= information.\\nOptionally\ + \ a ? could be added to reduce hub.\\nquery”:”eventType = ServiceOrderStateChangeNotification”\ + &serviceOrder.state=COMPLETED" + type: "string" + callback: + description: "URL where notification must be send" + type: "string" + Hub: + description: "" + required: + - "id" + - "query" + - "callback" + type: "object" + properties: + id: + description: "" + type: "string" + query: + description: "The query must have an eventType= information.\\nOptionally\ + \ a ? could be added to reduce hub.\\nquery”:”eventType = ServiceOrderStateChangeNotification”\ + &serviceOrder.state=COMPLETED" + type: "string" + callback: + description: "URL where notification must be send" + type: "string" |