From cf469f63cb490d90b55508efa331073a17297999 Mon Sep 17 00:00:00 2001 From: MatthieuGeerebaert Date: Tue, 12 Mar 2019 18:30:33 +0100 Subject: Update Swagger files Change-Id: I02a375b4998fdf23bd7c4eb391011a8e37a1c8e2 Issue-ID: EXTAPI-211 Signed-off-by: MatthieuGeerebaert --- docs/offeredapis/api_hub/api.plantuml | 30 + docs/offeredapis/api_hub/model.xsd | 83 + docs/offeredapis/api_hub/swagger.json | 279 ++ docs/offeredapis/api_hub/swagger.yaml | 180 + docs/offeredapis/api_serviceCatalog/api.plantuml | 110 + docs/offeredapis/api_serviceCatalog/model.xsd | 517 +++ docs/offeredapis/api_serviceCatalog/swagger.json | 659 ++++ docs/offeredapis/api_serviceCatalog/swagger.yaml | 488 +++ docs/offeredapis/api_serviceInventory/api.plantuml | 109 + docs/offeredapis/api_serviceInventory/model.xsd | 497 +++ docs/offeredapis/api_serviceInventory/swagger.json | 603 ++++ docs/offeredapis/api_serviceInventory/swagger.yaml | 398 +++ docs/offeredapis/api_serviceOrder/api.plantuml | 205 ++ docs/offeredapis/api_serviceOrder/model.xsd | 932 ++++++ docs/offeredapis/api_serviceOrder/swagger.json | 1110 +++++++ docs/offeredapis/api_serviceOrder/swagger.yaml | 784 +++++ docs/offeredapis/api_status/api.plantuml | 43 + docs/offeredapis/api_status/model.xsd | 114 + docs/offeredapis/api_status/swagger.json | 230 ++ docs/offeredapis/api_status/swagger.yaml | 145 + docs/offeredapis/images/text_xml.png | Bin 0 -> 5528 bytes docs/offeredapis/listener/apiListener.plantuml | 26 - docs/offeredapis/listener/asciiDoc.adoc | 175 - docs/offeredapis/listener/documentation.html | 779 ----- docs/offeredapis/listener/markDown.md | 122 - docs/offeredapis/offeredapis.rst | 21 +- .../serviceCatalog/apiServiceCatalog.plantuml | 110 - docs/offeredapis/serviceCatalog/asciiDoc.adoc | 492 --- docs/offeredapis/serviceCatalog/documentation.html | 1489 --------- docs/offeredapis/serviceCatalog/markDown.md | 299 -- .../serviceInventory/apiServiceInventory.plantuml | 89 - docs/offeredapis/serviceInventory/asciiDoc.adoc | 461 --- .../serviceInventory/documentation.html | 1432 -------- docs/offeredapis/serviceInventory/markDown.md | 287 -- .../serviceOrder/apiServiceOrder.plantuml | 242 -- docs/offeredapis/serviceOrder/asciiDoc.adoc | 1512 --------- docs/offeredapis/serviceOrder/documentation.html | 3503 -------------------- docs/offeredapis/serviceOrder/markDown.md | 890 ----- docs/offeredapis/swaggers/healthCheck_3_0_0.json | 61 - docs/offeredapis/swaggers/listener-1_0_0.json | 210 -- docs/offeredapis/swaggers/listener-1_0_0.yaml | 142 - .../offeredapis/swaggers/serviceCatalog_3_0_0.json | 660 ---- .../offeredapis/swaggers/serviceCatalog_3_0_0.yaml | 493 --- .../swaggers/serviceInventory_3_0_0.json | 614 ---- .../swaggers/serviceInventory_3_0_0.yaml | 419 --- docs/offeredapis/swaggers/serviceOrder_3_0_0.json | 2062 ------------ docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml | 1428 -------- 47 files changed, 7528 insertions(+), 18006 deletions(-) create mode 100644 docs/offeredapis/api_hub/api.plantuml create mode 100644 docs/offeredapis/api_hub/model.xsd create mode 100644 docs/offeredapis/api_hub/swagger.json create mode 100644 docs/offeredapis/api_hub/swagger.yaml create mode 100644 docs/offeredapis/api_serviceCatalog/api.plantuml create mode 100644 docs/offeredapis/api_serviceCatalog/model.xsd create mode 100644 docs/offeredapis/api_serviceCatalog/swagger.json create mode 100644 docs/offeredapis/api_serviceCatalog/swagger.yaml create mode 100644 docs/offeredapis/api_serviceInventory/api.plantuml create mode 100644 docs/offeredapis/api_serviceInventory/model.xsd create mode 100644 docs/offeredapis/api_serviceInventory/swagger.json create mode 100644 docs/offeredapis/api_serviceInventory/swagger.yaml create mode 100644 docs/offeredapis/api_serviceOrder/api.plantuml create mode 100644 docs/offeredapis/api_serviceOrder/model.xsd create mode 100644 docs/offeredapis/api_serviceOrder/swagger.json create mode 100644 docs/offeredapis/api_serviceOrder/swagger.yaml create mode 100644 docs/offeredapis/api_status/api.plantuml create mode 100644 docs/offeredapis/api_status/model.xsd create mode 100644 docs/offeredapis/api_status/swagger.json create mode 100644 docs/offeredapis/api_status/swagger.yaml create mode 100644 docs/offeredapis/images/text_xml.png delete mode 100644 docs/offeredapis/listener/apiListener.plantuml delete mode 100644 docs/offeredapis/listener/asciiDoc.adoc delete mode 100644 docs/offeredapis/listener/documentation.html delete mode 100644 docs/offeredapis/listener/markDown.md delete mode 100644 docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml delete mode 100644 docs/offeredapis/serviceCatalog/asciiDoc.adoc delete mode 100644 docs/offeredapis/serviceCatalog/documentation.html delete mode 100644 docs/offeredapis/serviceCatalog/markDown.md delete mode 100644 docs/offeredapis/serviceInventory/apiServiceInventory.plantuml delete mode 100644 docs/offeredapis/serviceInventory/asciiDoc.adoc delete mode 100644 docs/offeredapis/serviceInventory/documentation.html delete mode 100644 docs/offeredapis/serviceInventory/markDown.md delete mode 100644 docs/offeredapis/serviceOrder/apiServiceOrder.plantuml delete mode 100644 docs/offeredapis/serviceOrder/asciiDoc.adoc delete mode 100644 docs/offeredapis/serviceOrder/documentation.html delete mode 100644 docs/offeredapis/serviceOrder/markDown.md delete mode 100644 docs/offeredapis/swaggers/healthCheck_3_0_0.json delete mode 100644 docs/offeredapis/swaggers/listener-1_0_0.json delete mode 100644 docs/offeredapis/swaggers/listener-1_0_0.yaml delete mode 100644 docs/offeredapis/swaggers/serviceCatalog_3_0_0.json delete mode 100644 docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml delete mode 100644 docs/offeredapis/swaggers/serviceInventory_3_0_0.json delete mode 100644 docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml delete mode 100644 docs/offeredapis/swaggers/serviceOrder_3_0_0.json delete mode 100644 docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml (limited to 'docs/offeredapis') 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 @@ + + + + API Designer + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED + + + + + URL where notification must be send + + + + + + + + + + + + + + + + + + The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED + + + + + URL where notification must be send + + + + + 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" diff --git a/docs/offeredapis/api_serviceCatalog/api.plantuml b/docs/offeredapis/api_serviceCatalog/api.plantuml new file mode 100644 index 0000000..8483238 --- /dev/null +++ b/docs/offeredapis/api_serviceCatalog/api.plantuml @@ -0,0 +1,110 @@ +@startuml + +enum LifecycleStatusValues { + NOT_CERTIFIED_CHECKOUT + NOT_CERTIFIED_CHECKIN + READY_FOR_CERTIFICATION + CERTIFICATION_IN_PROGRESS + CERTIFIED +} +enum DistributionStatus { + DISTRIBUTION_NOT_APPROVED + DISTRIBUTION_APPROVED + DISTRIBUTED + DISTRIBUTION_REJECTED +} + +class ErrorRepresentation { + code:int + reason:string + message:string + status:string + referenceErrror:string + @type:string + @schemaLocation:string +} + +class TimePeriod { + startDateTime:dateTime + endDateTime:dateTime +} + +class RelatedPartyRef { + id:string + role:string + name:string +} + +class ServiceSpecification { + id:string + href:string + name:string + description:string + @type:string + @schemaLocation:string + @baseType:string + invariantUUID:string + toscaModelURL:string + toscaResourceName:string + category:string + subcategory:string + version:string +} + ServiceSpecification --> "0-1" DistributionStatus : distributionStatus + ServiceSpecification --> "0-1" LifecycleStatusValues : lifecycleStatus + ServiceSpecification --> "0-1" TargetServiceSchemaRef : targetServiceSchema + ServiceSpecification --> "0-*" Attachment : attachment + ServiceSpecification --> "0-*" RelatedPartyRef : relatedParty + ServiceSpecification --> "0-*" ResourceSpecificationRef : resourceSpecification + ServiceSpecification --> "0-*" ServiceSpecCharacteristic : serviceSpecCharacteristic + +class ServiceSpecCharacteristic { + name:string + description:string + valueType:string + @type:string + @schemaLocation:string + required:boolean + status:string +} + ServiceSpecCharacteristic --> "0-*" ServiceSpecCharacteristicValue : serviceSpecCharacteristicValue + +class Attachment { + id:string + name:string + description:string + @type:string + artifactLabel:string + artifactGroupType:string + artifactTimeout:string + artifactChecksum:string + artifactVersion:string + generatedFromUUID:string + url:string + mimeType:string +} + +class ServiceSpecCharacteristicValue { + valueType:string + isDefault:boolean + value:string +} + +class ResourceSpecificationRef { + id:string + version:string + name:string + @type:string + resourceInstanceName:string + resourceInvariantUUID:string + resourceType:string + modelCustomizationName:string + modelCustomizationId:string +} + +class TargetServiceSchemaRef { + @type:string + @schemaLocation:string +} + +@enduml \ No newline at end of file diff --git a/docs/offeredapis/api_serviceCatalog/model.xsd b/docs/offeredapis/api_serviceCatalog/model.xsd new file mode 100644 index 0000000..26625c2 --- /dev/null +++ b/docs/offeredapis/api_serviceCatalog/model.xsd @@ -0,0 +1,517 @@ + + + + API Designer + Model: serviceCatalog + Version: 3.0.0_tag + Owner: ONAPNBI + Generated on: 2019-03-12T17:02:42.013Z + Generated by: Orange API Designer v2, model-v1 + + + + + + + + + + + + + + + + + + + + + This class is used to describe error. +for nbi Beijing release we do not manage additional error for serviceCatalog + + + + + This class is used to describe error. +for nbi Beijing release we do not manage additional error for serviceCatalog + + + + + Application related code (as defined in the API or from a common list) + + + + + Text that explains the reason for error. This can be shown to a client user. + + + + + Text that provide more details and corrective actions related to the error. This can be shown to a client user + + + + + http error code extension like 400-2 + + + + + url pointing to documentation describing the error + + + + + The class type of a REST resource. + + + + + it provides a link to the schema describing a REST resource. + + + + + + + A time period + + + + + A time period + + + + + Start date and time of the period + + + + + End date and time of the period + + + + + + + Party linked to the service catalog. +in nbi we retrieve information about last updater of the service in SDC + + + + + Party linked to the service catalog. +in nbi we retrieve information about last updater of the service in SDC + + + + + Unique identifier of the related party. Filled with lastUpdaterUserId + + + + + Role payed by the related party +Only role 'lastUpdater' is retrieved in Beijing release + + + + + Name of the related party - Filled with lastUpdatedFullName + + + + + + + ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. +the service information are retrieved in SDC + + + + + ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. +the service information are retrieved in SDC + + + + + Unique identifier of the service specification. Filled with SDC Service uuid + + + + + Reference of the service specification- not mapped in Beijing + + + + + Name of the service specification- Filled with SDC Service name + + + + + A narrative that explains in detail what the service specification is - Filled with SDC Service description + + + + + This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes: +invariantUUID +toscaModelURL +toscaResourceName +category (1) +subcategory (1) +distributionStatus + + + + + Not used for Beijing release + + + + + Not used for Beijing release + + + + + Additional attribute (not in the TMF API) - extended through @type - invariantUUID + + + + + Additional attribute (not in the TMF API) - extended through @type - toscaModelURL + + + + + Additional attribute (not in the TMF API) - extended through @type - toscaResourceName + + + + + Additional attribute - extended through @type - category +Please note that this attribute is managed in TMF - in future release we'll introduce category resource + + + + + Additional attribute - extended through @type - category +Please note that this attribute is managed in TMF - in future release we'll introduce category resourc + + + + + Additional attribute - extended through @type - distributionStatus + + + + + Service specification version - Filled with SDC Service version + + + + + Service Current status in the catalog - Filled with SDC Service life cycle state + + + + + Not used in Beijing release + + + + + A list of attachments concerning the service specification - Used to retrieve service artifacts + + + + + A list of parties linked to the service specification - Used to retrieve lastUpdater informative + + + + + A list of resource specification usable to deliver this service - used to retrieve resource + + + + + A list of characteristic features of the service specification + + + + + + + A characteristic quality or distinctive feature of a ServiceSpecification. +ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. + + + + + A characteristic quality or distinctive feature of a ServiceSpecification. +ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. + + + + + Name of the characteristic - Filled with parameter_name + + + + + A narrative that explains in detail what the characteristic is - Filled with parameter_description + + + + + A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type + + + + + This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release. + + + + + An url pointing to type description - we do not use it in nbi Beijing release + + + + + A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’ + + + + + Status of the characteristic - filled with status_value + + + + + Value that can be assigned to a characteristic + + + + + + + An attachment is a file uses to describe the service. +In nbi we use attachment to retrieve ONAP artifacts. + + + + + An attachment is a file uses to describe the service. +In nbi we use attachment to retrieve ONAP artifacts. + + + + + Unique identifier of the attachment - filled with artifactUUID. + + + + + Name of the attachment - filled with artifactName + + + + + Description of the attachment - filled with artifactDescription + + + + + This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: +artifactLabel +artifactGroupType +artifactTimeout +artifactChecksum +artifactVersion +generatedFromUUID + + + + + Additional attribute (not in the TMF API) - extended through @type - artifactLabel + + + + + Additional attribute (not in the TMF API) - extended through @type - artifactGroupType + + + + + Additional attribute (not in the TMF API) - extended through @type - artifactTimeout + + + + + Additional attribute (not in the TMF API) - extended through @type - artifactChecksum + + + + + Additional attribute (not in the TMF API) - extended through @type - artifactVersion + + + + + Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID + + + + + Uniform Resource Locator, is a web page address - filled with artifactURL + + + + + Filled with artifactType + + + + + + + A number or text that can be assigned to a service specification characteristic. +ServiceSpecCharacteristicValue are retrieved in the service Tosca file + + + + + A number or text that can be assigned to a service specification characteristic. +ServiceSpecCharacteristicValue are retrieved in the service Tosca file + + + + + A kind of value that the characteristic can take on, such as numeric, text, and so forth +Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. +We do not manage parameter_type= list or map for Beijing release + + + + + Information calculated from parameter default in the Tosca file + + + + + A discrete value that the characteristic can take on + + + + + + + A list of resourceSpec identified to deliver the service. +for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. + + + + + A list of resourceSpec identified to deliver the service. +for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. + + + + + Unique identifier of the resource specification - filled with resourceUUID + + + + + Version for this resource specification - filled with resourceVersion + + + + + Name of the resource specification - filled with resourceName + + + + + This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes: +resourceInstanceName +resourceInvariantUUID +resourceType +modelCustomizationName +modelCustomizationId + + + + + Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName + + + + + Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID + + + + + Additional attribute (not in the TMF API) - extended through @type - resoucreType + + + + + Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource + + + + + Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource + + + + + + + + + + + + + + + + + + + diff --git a/docs/offeredapis/api_serviceCatalog/swagger.json b/docs/offeredapis/api_serviceCatalog/swagger.json new file mode 100644 index 0000000..fcb84d2 --- /dev/null +++ b/docs/offeredapis/api_serviceCatalog/swagger.json @@ -0,0 +1,659 @@ + + { + "swagger": "2.0", + "info": { + "description": "serviceCatalog API designed for ONAP Beijing Release.\nThis API is build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource serviceSpecification is available\n\n", + "version": "3.0.0_tag", + "title": "API ServiceCatalog", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "serverRoot", + "basePath": "/nbi/api/v1", + "schemes": [ + "https" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "ServiceSpecification", + "description": "" + } + ], + "paths": { + "/serviceSpecification": { + "get": { + "tags": [ + "ServiceSpecification" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceSpecificationFind", + "summary": "List service specifications", + "description": "This operation returns service specifications from a catalog.\nOnly a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering\nFields attribute could be used to filter attributes retrieved", + "deprecated": false, + + "parameters": [ + + { + "name": "fields", + "required": false, + "in": "query", + "description": "Field selection - used to filtering the attributes to be retreived", + + "type": "string" + }, + { + "name": "category", + "required": false, + "in": "query", + "description": "Service Category (filter)", + + "type": "string" + }, + { + "name": "distributionStatus", + "required": false, + "in": "query", + "description": "Service distribution status (filter)", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceSpecification" + } + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/serviceSpecification/{id}": { + "get": { + "tags": [ + "ServiceSpecification" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceSpecificationGet", + "summary": "Retrieve a service specification", + "description": "This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "required": true, + "in": "path", + "type" : "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "Attribute selection", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ServiceSpecification" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + } + }, + "definitions": { + + "LifecycleStatusValues": { + "description": "Service lifecycle value from ONAP SDC", + + "type": "string", + "enum": [ + "NOT_CERTIFIED_CHECKOUT", + "NOT_CERTIFIED_CHECKIN", + "READY_FOR_CERTIFICATION", + "CERTIFICATION_IN_PROGRESS", + "CERTIFIED"] + + }, + "DistributionStatus": { + "description": "Service distribution status from ONAP.", + + "type": "string", + "enum": [ + "DISTRIBUTION_NOT_APPROVED", + "DISTRIBUTION_APPROVED", + "DISTRIBUTED", + "DISTRIBUTION_REJECTED"] + + }, + + "ErrorRepresentation": { + "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceErrror": { + "description": "url pointing to documentation describing the error", + "type": "string" + }, + "@type": { + "description": "The class type of a REST resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "it provides a link to the schema describing a REST resource.", + "type": "string" + } + } + + }, + + "TimePeriod": { + "description": "A time period", + + + "type": "object", + "properties": { + "startDateTime": { + "description": "Start date and time of the period", + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "description": "End date and time of the period", + "type": "string", + "format": "date-time" + } + } + + }, + + "RelatedPartyRef": { + "description": "Party linked to the service catalog.\nin nbi we retrieve information about last updater of the service in SDC", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the related party. Filled with lastUpdaterUserId", + "type": "string" + }, + "role": { + "description": "Role payed by the related party\nOnly role 'lastUpdater' is retrieved in Beijing release", + "type": "string" + }, + "name": { + "description": "Name of the related party - Filled with lastUpdatedFullName", + "type": "string" + } + } + + }, + + "ServiceSpecification": { + "description": "ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.\nthe service information are retrieved in SDC", + + + "required": [ + + "invariantUUID" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification. Filled with SDC Service uuid", + "type": "string" + }, + "href": { + "description": "Reference of the service specification- not mapped in Beijing", + "type": "string" + }, + "name": { + "description": "Name of the service specification- Filled with SDC Service name", + "type": "string" + }, + "description": { + "description": "A narrative that explains in detail what the service specification is - Filled with SDC Service description", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:\ninvariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory (1)\ndistributionStatus", + "type": "string", + + "default": "ONAPservice" + }, + "@schemaLocation": { + "description": "Not used for Beijing release", + "type": "string" + }, + "@baseType": { + "description": "Not used for Beijing release", + "type": "string" + }, + "invariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @type - invariantUUID", + "type": "string" + }, + "toscaModelURL": { + "description": "Additional attribute (not in the TMF API) - extended through @type - toscaModelURL", + "type": "string" + }, + "toscaResourceName": { + "description": "Additional attribute (not in the TMF API) - extended through @type - toscaResourceName", + "type": "string" + }, + "category": { + "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resource", + "type": "string" + }, + "subcategory": { + "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resourc", + "type": "string" + }, + "distributionStatus": { + + "$ref": "#/definitions/DistributionStatus" + }, + "version": { + "description": "Service specification version - Filled with SDC Service version", + "type": "string" + }, + "lifecycleStatus": { + + "$ref": "#/definitions/LifecycleStatusValues" + }, + "targetServiceSchema": { + + "$ref": "#/definitions/TargetServiceSchemaRef" + }, + "attachment": { + + "type": "array", + "items": { + "$ref": "#/definitions/Attachment" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedPartyRef" + } + }, + "resourceSpecification": { + + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSpecificationRef" + } + }, + "serviceSpecCharacteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceSpecCharacteristic" + } + } + } + + }, + + "ServiceSpecCharacteristic": { + "description": "A characteristic quality or distinctive feature of a ServiceSpecification. \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.", + + + "type": "object", + "properties": { + "name": { + "description": "Name of the characteristic - Filled with parameter_name", + "type": "string" + }, + "description": { + "description": "A narrative that explains in detail what the characteristic is - Filled with parameter_description", + "type": "string" + }, + "valueType": { + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.", + "type": "string" + }, + "@schemaLocation": { + "description": "An url pointing to type description - we do not use it in nbi Beijing release", + "type": "string" + }, + "required": { + "description": "A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’", + "type": "boolean", + + "default": true + }, + "status": { + "description": "Status of the characteristic - filled with status_value", + "type": "string" + }, + "serviceSpecCharacteristicValue": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceSpecCharacteristicValue" + } + } + } + + }, + + "Attachment": { + "description": "An attachment is a file uses to describe the service.\nIn nbi we use attachment to retrieve ONAP artifacts.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the attachment - filled with artifactUUID.", + "type": "string" + }, + "name": { + "description": "Name of the attachment - filled with artifactName", + "type": "string" + }, + "description": { + "description": "Description of the attachment - filled with artifactDescription", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\nartifactVersion\ngeneratedFromUUID", + "type": "string", + + "default": "ONAPartifact" + }, + "artifactLabel": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactLabel", + "type": "string" + }, + "artifactGroupType": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactGroupType", + "type": "string" + }, + "artifactTimeout": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactTimeout", + "type": "string" + }, + "artifactChecksum": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactChecksum", + "type": "string" + }, + "artifactVersion": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactVersion", + "type": "string" + }, + "generatedFromUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID", + "type": "string" + }, + "url": { + "description": "Uniform Resource Locator, is a web page address - filled with artifactURL", + "type": "string" + }, + "mimeType": { + "description": "Filled with artifactType", + "type": "string" + } + } + + }, + + "ServiceSpecCharacteristicValue": { + "description": "A number or text that can be assigned to a service specification characteristic.\nServiceSpecCharacteristicValue are retrieved in the service Tosca file", + + + "type": "object", + "properties": { + "valueType": { + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth\nRetrieved in the Tosca in the topology_template section in the inputs section - parameter_type. \nWe do not manage parameter_type= list or map for Beijing release", + "type": "string" + }, + "isDefault": { + "description": "Information calculated from parameter default in the Tosca file", + "type": "boolean" + }, + "value": { + "description": "A discrete value that the characteristic can take on", + "type": "string" + } + } + + }, + + "ResourceSpecificationRef": { + "description": "A list of resourceSpec identified to deliver the service.\nfor nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the resource specification - filled with resourceUUID", + "type": "string" + }, + "version": { + "description": "Version for this resource specification - filled with resourceVersion", + "type": "string" + }, + "name": { + "description": "Name of the resource specification - filled with resourceName", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:\nresourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\nmodelCustomizationId", + "type": "string", + + "default": "ONAPresource" + }, + "resourceInstanceName": { + "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName", + "type": "string" + }, + "resourceInvariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID", + "type": "string" + }, + "resourceType": { + "description": "Additional attribute (not in the TMF API) - extended through @type - resoucreType", + "type": "string" + }, + "modelCustomizationName": { + "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource", + "type": "string" + }, + "modelCustomizationId": { + "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource", + "type": "string" + } + } + + }, + + "TargetServiceSchemaRef": { + "description": "", + + + "required": [ + + "@type", + "@schemaLocation" + ], + "type": "object", + "properties": { + "@type": { + "description": "", + "type": "string" + }, + "@schemaLocation": { + "description": "", + "type": "string" + } + } + + } + } + } + \ No newline at end of file diff --git a/docs/offeredapis/api_serviceCatalog/swagger.yaml b/docs/offeredapis/api_serviceCatalog/swagger.yaml new file mode 100644 index 0000000..a951625 --- /dev/null +++ b/docs/offeredapis/api_serviceCatalog/swagger.yaml @@ -0,0 +1,488 @@ +swagger: "2.0" +info: + description: "serviceCatalog API designed for ONAP Beijing Release.\nThis API is\ + \ build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource\ + \ serviceSpecification is available\n\n" + version: "3.0.0_tag" + title: "API ServiceCatalog" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "serverRoot" +basePath: "/nbi/api/v1" +schemes: +- "https" +produces: +- "application/json;charset=utf-8" +tags: +- name: "ServiceSpecification" + description: "" +paths: + /serviceSpecification: + get: + tags: + - "ServiceSpecification" + produces: + - "application/json;charset=utf-8" + operationId: "serviceSpecificationFind" + summary: "List service specifications" + description: "This operation returns service specifications from a catalog.\n\ + Only a predefined set of attribute is proposed : Based on SDC limitations,\ + \ only attributes category and distributionStatus are available for serviceSpecification\ + \ filtering\nFields attribute could be used to filter attributes retrieved" + deprecated: false + parameters: + - name: "fields" + required: false + in: "query" + description: "Field selection - used to filtering the attributes to be retreived" + type: "string" + - name: "category" + required: false + in: "query" + description: "Service Category (filter)" + type: "string" + - name: "distributionStatus" + required: false + in: "query" + description: "Service distribution status (filter)" + type: "string" + responses: + 200: + description: "Ok" + schema: + type: "array" + items: + $ref: "#/definitions/ServiceSpecification" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /serviceSpecification/{id}: + get: + tags: + - "ServiceSpecification" + produces: + - "application/json;charset=utf-8" + operationId: "serviceSpecificationGet" + summary: "Retrieve a service specification" + description: "This operation returns a service specification by its id from\ + \ a catalog. Attribute selection is enabled using the fields attribute." + deprecated: false + parameters: + - name: "id" + required: true + in: "path" + type: "string" + - name: "fields" + required: false + in: "query" + description: "Attribute selection" + type: "string" + responses: + 200: + description: "Ok" + schema: + $ref: "#/definitions/ServiceSpecification" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" +definitions: + LifecycleStatusValues: + description: "Service lifecycle value from ONAP SDC" + type: "string" + enum: + - "NOT_CERTIFIED_CHECKOUT" + - "NOT_CERTIFIED_CHECKIN" + - "READY_FOR_CERTIFICATION" + - "CERTIFICATION_IN_PROGRESS" + - "CERTIFIED" + DistributionStatus: + description: "Service distribution status from ONAP." + type: "string" + enum: + - "DISTRIBUTION_NOT_APPROVED" + - "DISTRIBUTION_APPROVED" + - "DISTRIBUTED" + - "DISTRIBUTION_REJECTED" + ErrorRepresentation: + description: "This class is used to describe error.\nfor nbi Beijing release we\ + \ do not manage additional error for serviceCatalog" + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user" + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceErrror: + description: "url pointing to documentation describing the error" + type: "string" + '@type': + description: "The class type of a REST resource." + type: "string" + '@schemaLocation': + description: "it provides a link to the schema describing a REST resource." + type: "string" + TimePeriod: + description: "A time period" + type: "object" + properties: + startDateTime: + description: "Start date and time of the period" + type: "string" + format: "date-time" + endDateTime: + description: "End date and time of the period" + type: "string" + format: "date-time" + RelatedPartyRef: + description: "Party linked to the service catalog.\nin nbi we retrieve information\ + \ about last updater of the service in SDC" + type: "object" + properties: + id: + description: "Unique identifier of the related party. Filled with lastUpdaterUserId" + type: "string" + role: + description: "Role payed by the related party\nOnly role 'lastUpdater' is\ + \ retrieved in Beijing release" + type: "string" + name: + description: "Name of the related party - Filled with lastUpdatedFullName" + type: "string" + ServiceSpecification: + description: "ServiceSpecification is a class that offers characteristics to describe\ + \ a type of service. Functionally, it acts as a template by which Services may\ + \ be instantiated. By sharing the same specification, these services would therefore\ + \ share the same set of characteristics.\nthe service information are retrieved\ + \ in SDC" + required: + - "invariantUUID" + type: "object" + properties: + id: + description: "Unique identifier of the service specification. Filled with\ + \ SDC Service uuid" + type: "string" + href: + description: "Reference of the service specification- not mapped in Beijing" + type: "string" + name: + description: "Name of the service specification- Filled with SDC Service name" + type: "string" + description: + description: "A narrative that explains in detail what the service specification\ + \ is - Filled with SDC Service description" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPservice'. We used this features to add following attributes:\n\ + invariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory\ + \ (1)\ndistributionStatus" + type: "string" + default: "ONAPservice" + '@schemaLocation': + description: "Not used for Beijing release" + type: "string" + '@baseType': + description: "Not used for Beijing release" + type: "string" + invariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - invariantUUID" + type: "string" + toscaModelURL: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - toscaModelURL" + type: "string" + toscaResourceName: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - toscaResourceName" + type: "string" + category: + description: "Additional attribute - extended through @type - category\nPlease\ + \ note that this attribute is managed in TMF - in future release we'll introduce\ + \ category resource" + type: "string" + subcategory: + description: "Additional attribute - extended through @type - category\nPlease\ + \ note that this attribute is managed in TMF - in future release we'll introduce\ + \ category resourc" + type: "string" + distributionStatus: + $ref: "#/definitions/DistributionStatus" + version: + description: "Service specification version - Filled with SDC Service version" + type: "string" + lifecycleStatus: + $ref: "#/definitions/LifecycleStatusValues" + targetServiceSchema: + $ref: "#/definitions/TargetServiceSchemaRef" + attachment: + type: "array" + items: + $ref: "#/definitions/Attachment" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedPartyRef" + resourceSpecification: + type: "array" + items: + $ref: "#/definitions/ResourceSpecificationRef" + serviceSpecCharacteristic: + type: "array" + items: + $ref: "#/definitions/ServiceSpecCharacteristic" + ServiceSpecCharacteristic: + description: "A characteristic quality or distinctive feature of a ServiceSpecification.\ + \ \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the\ + \ topology_template section in the inputs section." + type: "object" + properties: + name: + description: "Name of the characteristic - Filled with parameter_name" + type: "string" + description: + description: "A narrative that explains in detail what the characteristic\ + \ is - Filled with parameter_description" + type: "string" + valueType: + description: "A kind of value that the characteristic can take on, such as\ + \ numeric, text and so forth - Filled with parameter_type" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with: 'ONAPserviceCharacteristic'. We do not used this features in nbi\ + \ Beijing release." + type: "string" + '@schemaLocation': + description: "An url pointing to type description - we do not use it in nbi\ + \ Beijing release" + type: "string" + required: + description: "A parameter to define if the characteristic is mandatory - Filled\ + \ from parameter_required – if not fielded by default ‘true’" + type: "boolean" + default: true + status: + description: "Status of the characteristic - filled with status_value" + type: "string" + serviceSpecCharacteristicValue: + type: "array" + items: + $ref: "#/definitions/ServiceSpecCharacteristicValue" + Attachment: + description: "An attachment is a file uses to describe the service.\nIn nbi we\ + \ use attachment to retrieve ONAP artifacts." + type: "object" + properties: + id: + description: "Unique identifier of the attachment - filled with artifactUUID." + type: "string" + name: + description: "Name of the attachment - filled with artifactName" + type: "string" + description: + description: "Description of the attachment - filled with artifactDescription" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPartifact'. We used this features to add following attributes:\ + \ \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\n\ + artifactVersion\ngeneratedFromUUID" + type: "string" + default: "ONAPartifact" + artifactLabel: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactLabel" + type: "string" + artifactGroupType: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactGroupType" + type: "string" + artifactTimeout: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactTimeout" + type: "string" + artifactChecksum: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactChecksum" + type: "string" + artifactVersion: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactVersion" + type: "string" + generatedFromUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - generatedFromUUID" + type: "string" + url: + description: "Uniform Resource Locator, is a web page address - filled with\ + \ artifactURL" + type: "string" + mimeType: + description: "Filled with artifactType" + type: "string" + ServiceSpecCharacteristicValue: + description: "A number or text that can be assigned to a service specification\ + \ characteristic.\nServiceSpecCharacteristicValue are retrieved in the service\ + \ Tosca file" + type: "object" + properties: + valueType: + description: "A kind of value that the characteristic can take on, such as\ + \ numeric, text, and so forth\nRetrieved in the Tosca in the topology_template\ + \ section in the inputs section - parameter_type. \nWe do not manage parameter_type=\ + \ list or map for Beijing release" + type: "string" + isDefault: + description: "Information calculated from parameter default in the Tosca file" + type: "boolean" + value: + description: "A discrete value that the characteristic can take on" + type: "string" + ResourceSpecificationRef: + description: "A list of resourceSpec identified to deliver the service.\nfor nbi\ + \ we retrieve resource information available in service description (through\ + \ SDC api) bu as well information retrieved in the TOSCA file." + type: "object" + properties: + id: + description: "Unique identifier of the resource specification - filled with\ + \ resourceUUID" + type: "string" + version: + description: "Version for this resource specification - filled with resourceVersion" + type: "string" + name: + description: "Name of the resource specification - filled with resourceName" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with: 'ONAPresource'. We used this features to add following attributes:\n\ + resourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\n\ + modelCustomizationId" + type: "string" + default: "ONAPresource" + resourceInstanceName: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - resourceInstanceName" + type: "string" + resourceInvariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - resourceInvariantUUID" + type: "string" + resourceType: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - resoucreType" + type: "string" + modelCustomizationName: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template\ + \ for the resource" + type: "string" + modelCustomizationId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template\ + \ for the resource" + type: "string" + TargetServiceSchemaRef: + description: "" + required: + - "@type" + - "@schemaLocation" + type: "object" + properties: + '@type': + description: "" + type: "string" + '@schemaLocation': + description: "" + type: "string" diff --git a/docs/offeredapis/api_serviceInventory/api.plantuml b/docs/offeredapis/api_serviceInventory/api.plantuml new file mode 100644 index 0000000..3805ae9 --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/api.plantuml @@ -0,0 +1,109 @@ +@startuml + +enum eventType { + ServiceCreationNotification + ServiceAttributeValueChangeNotification + ServiceRemoveNotification +} + +class ErrorRepresentation { + code:int + reason:string + message:string + status:string + referenceError:string + @type:string + @schemaLocation:string +} + +class Service { + id:string + href:string + name:string + type:string + state:string + @type:string + @baseType:string + @schemaLocation:string +} + Service --> "0-1" ServiceSpecificationRef : serviceSpecification + Service --> "0-*" ServiceCharacteristic : characteristic + Service --> "0-*" SupportingResource : supportingResource + Service --> "0-*" RelatedPartyRef : relatedParty + +class ServiceSpecificationRef { + id:string + href:string + name:string + version:string + @referredType:string + @schemaLocation:string + invariantUUID:string +} + +class ServiceCharacteristic { + name:string + valueType:string +} + ServiceCharacteristic --> "0-1" Value : value + +class SupportingResource { + id:string + href:string + role:string + name:string + @referredType:string + @schemaLocation:string + status:string + modelInvariantId:string + modelVersionId:string + modelCustomisationId:string +} + +class RelatedPartyRef { + id:string + href:string + role:string + @referredType:string +} + +class Value { + @type:string + @schemaLocation:string + serviceCharacteristicValue:string +} + +class ListRelatedPartyRef { + id:string + role:string +} + +class ListServiceSpecificationRef { + id:string + name:string +} + +class ListService { + id:string + name:string +} + ListService --> "0-1" ListServiceSpecificationRef : serviceSpecification + ListService --> "0-1" ListRelatedPartyRef : relatedParty + +class ServiceInventoryEvent { + id:string + href:string + name:string + type:string + state:string +} + ServiceInventoryEvent --> "1-1" RelatedPartyRef : relatedParty + +class Notification { + eventId:string + eventDate:dateTime +} + Notification --> "1-1" eventType : eventType + Notification --> "1-1" ServiceInventoryEvent : event + +@enduml \ No newline at end of file diff --git a/docs/offeredapis/api_serviceInventory/model.xsd b/docs/offeredapis/api_serviceInventory/model.xsd new file mode 100644 index 0000000..2c46857 --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/model.xsd @@ -0,0 +1,497 @@ + + + + API Designer + Model: serviceInventory + Version: 4.0.0_inProgress + Owner: ONAPNBI + Generated on: 2019-03-12T16:45:37.288Z + Generated by: Orange API Designer v2, model-v1 + + + + + + + + + + + This class is used to describe error. + + + + + This class is used to describe error. + + + + + Application related code (as defined in the API or from a common list) + + + + + Text that explains the reason for error. This can be shown to a client user. + + + + + Text that provide more details and corrective actions related to the error. This can be shown to a client user. + + + + + http error code extension like 400-2 + + + + + url pointing to documentation describing the error + + + + + The class type of a REST resource. + + + + + it provides a link to the schema describing a REST resource. + + + + + + + Instantiated service (service_instance) in AAI + + + + + Instantiated service (service_instance) in AAI + + + + + Unique identifier of the service - Valued with service-instance-id + + + + + Reference of the service +Not managed in Beijing release + + + + + Name of the service - Valued with service-instance-name + + + + + Service type - valued with 'service-instance' + + + + + State of the service. + + + + + This attribute allows to dynamically extends TMF class. Not used in Beijing release. + + + + + Not managed in Beijing release + + + + + Not managed in Beijing release + + + + + A service specification reference required to realize a ProductSpecification + + + + + A list of service characteristics i.e. name/value pairs that define the service characteristics + + + + + A list of supporting resources +A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf + + + + + A list of related party references . A related party defines party or party role linked to a specific entity. + + + + + + + Service specification reference: ServiceSpecification of this service (catalog information) + + + + + Service specification reference: ServiceSpecification of this service (catalog information) + + + + + Unique identifier of the service specification. valued to model-version-id + + + + + Reference of the service specification. +not managed in Beijing release. + + + + + Name of the required service specification + + + + + Service specification version. +Not managed in Beijing release + + + + + This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID + + + + + Not managed in Beijing release + + + + + Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id + + + + + + + A list of name value pairs that define the service characteristics +Not managed in Beijing release. + + + + + A list of name value pairs that define the service characteristics +Not managed in Beijing release. + + + + + Name of the characteristic +Not managed in Beijing release. + + + + + Type of value for this characteristic. +Not managed in Beijing release. + + + + + Value of the characteristic +Not managed in Beijing release. + + + + + + + Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf + + + + + Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf + + + + + Unique identifier of the supporting resource - Valued to vnf-id + + + + + Reference of the supporting resource + + + + + Not managed in Beijing release. + + + + + Name of the supporting resource - Valued with vnf_-name + + + + + This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes: + status + modelInvariantId + modelVersionId + modelCustomisationId + + + + + Not managed in Beijing release. + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id + + + + + + + RelatedParty reference. A related party defines party or party role linked to a specific entity. + + + + + RelatedParty reference. A related party defines party or party role linked to a specific entity. + + + + + Unique identifier of a related party + + + + + Reference of a related party. +Not filled in Beijing release. + + + + + Role played by the related party. +Filled with 'ONAPcustomer' + + + + + Not managed in the Beijing release. + + + + + + + Structure used to describe characteristic value. +Not managed in Beijing release. + + + + + Structure used to describe characteristic value. +Not managed in Beijing release. + + + + + Not managed in Beijing release. + + + + + Not managed in Beijing release. + + + + + Not managed in Beijing release. + + + + + + + This class is used to structure list of service(s) retrieved + + + + + This class is used to structure list of service(s) retrieved + + + + + Unique identifier of a related party + + + + + Role played by the related party - only role “ONAPcustomer” is managed in Beijing release. + + + + + + + This class is used to structure list of service(s) retrieved + + + + + This class is used to structure list of service(s) retrieved + + + + + Unique identifier of the service specification + + + + + Name of the required service specification + + + + + + + This class is used to structure list of service(s) retrieved + + + + + This class is used to structure list of service(s) retrieved + + + + + Unique identifier of the service + + + + + Name of the service + + + + + A service specification reference required to realize a ProductSpecification + + + + + Related Party to the service (only ONAP customer is managed) + + + + + + + Structure for a service inventory event notification + + + + + Structure for a service inventory event notification + + + + + The Service Instance Id + + + + + A reference to the service inventory + + + + + The name of the Service Instance + + + + + The type of event, service-instance + + + + + The state of the service instance + + + + + + + + Notification structure for a service notification + + + + + Notification structure for a service notification + + + + + + + + + diff --git a/docs/offeredapis/api_serviceInventory/swagger.json b/docs/offeredapis/api_serviceInventory/swagger.json new file mode 100644 index 0000000..81b882d --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/swagger.json @@ -0,0 +1,603 @@ + + { + "swagger": "2.0", + "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.0_inProgress", + "title": "API ServiceInventory", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "localhost:8080", + "basePath": "/nbi/api/v4", + "schemes": [ + "http" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "Service", + "description": "Provided by NBI" + }, + { + "name": "Notification", + "description": "provided by subscriber, which MUST has been registered by creating a Hub ressource on NBI" + } + ], + "paths": { + "/service": { + "get": { + "tags": [ + "Service" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceFind", + "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, + + "parameters": [ + + { + "name": "relatedParty.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.name", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ListService" + } + } + + } + } + } + }, + "/service/{id}": { + "get": { + "tags": [ + "Service" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceGet", + "summary": "Retrieve a service", + "description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "required": true, + "in": "path", + "type" : "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Service" + } + + } + } + } + }, + "/notification": { + "post": { + "tags": [ + "Notification" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "notificationCreate", + "summary": "NBI will send notification to this operation provided by subscribers", + "description": "", + "deprecated": false, + + "parameters": [ + + { + "name": "Notification", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/Notification" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Notification" + } + + } + } + } + } + }, + "definitions": { + + "eventType": { + "description": "", + + "type": "string", + "enum": [ + "ServiceCreationNotification", + "ServiceAttributeValueChangeNotification", + "ServiceRemoveNotification"] + + }, + + "ErrorRepresentation": { + "description": "This class is used to describe error.", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user.", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceError": { + "description": "url pointing to documentation describing the error", + "type": "string" + }, + "@type": { + "description": "The class type of a REST resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "it provides a link to the schema describing a REST resource.", + "type": "string" + } + } + + }, + + "Service": { + "description": "Instantiated service (service_instance) in AAI", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service - Valued with service-instance-id", + "type": "string" + }, + "href": { + "description": "Reference of the service\nNot managed in Beijing release", + "type": "string" + }, + "name": { + "description": "Name of the service - Valued with service-instance-name", + "type": "string" + }, + "type": { + "description": "Service type - valued with 'service-instance'", + "type": "string" + }, + "state": { + "description": "State of the service.", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Not used in Beijing release.", + "type": "string" + }, + "@baseType": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "serviceSpecification": { + + "$ref": "#/definitions/ServiceSpecificationRef" + }, + "characteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCharacteristic" + } + }, + "supportingResource": { + + "type": "array", + "items": { + "$ref": "#/definitions/SupportingResource" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedPartyRef" + } + } + } + + }, + + "ServiceSpecificationRef": { + "description": "Service specification reference: ServiceSpecification of this service (catalog information)", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification. valued to model-version-id", + "type": "string" + }, + "href": { + "description": "Reference of the service specification.\nnot managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the required service specification", + "type": "string" + }, + "version": { + "description": "Service specification version.\nNot managed in Beijing release", + "type": "string" + }, + "@referredType": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "invariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id", + "type": "string" + } + } + + }, + + "ServiceCharacteristic": { + "description": "A list of name value pairs that define the service characteristics\nNot managed in Beijing release.", + + + "required": [ + + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the characteristic\nNot managed in Beijing release.", + "type": "string" + }, + "valueType": { + "description": "Type of value for this characteristic.\nNot managed in Beijing release.", + "type": "string" + }, + "value": { + + "$ref": "#/definitions/Value" + } + } + + }, + + "SupportingResource": { + "description": "Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the supporting resource - Valued to vnf-id", + "type": "string" + }, + "href": { + "description": "Reference of the supporting resource", + "type": "string" + }, + "role": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the supporting resource - Valued with vnf_-name", + "type": "string" + }, + "@referredType": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:\n status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "status": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status", + "type": "string" + }, + "modelInvariantId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id", + "type": "string" + }, + "modelVersionId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id", + "type": "string" + }, + "modelCustomisationId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id", + "type": "string" + } + } + + }, + + "RelatedPartyRef": { + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "href": { + "description": "Reference of a related party.\nNot filled in Beijing release.", + "type": "string" + }, + "role": { + "description": "Role played by the related party.\nFilled with 'ONAPcustomer'", + "type": "string" + }, + "@referredType": { + "description": "Not managed in the Beijing release.", + "type": "string" + } + } + + }, + + "Value": { + "description": "Structure used to describe characteristic value.\nNot managed in Beijing release.", + + + "type": "object", + "properties": { + "@type": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "serviceCharacteristicValue": { + "description": "Not managed in Beijing release.", + "type": "string" + } + } + + }, + + "ListRelatedPartyRef": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "role": { + "description": "Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.", + "type": "string" + } + } + + }, + + "ListServiceSpecificationRef": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification", + "type": "string" + }, + "name": { + "description": "Name of the required service specification", + "type": "string" + } + } + + }, + + "ListService": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "name": { + "description": "Name of the service", + "type": "string" + }, + "serviceSpecification": { + + "$ref": "#/definitions/ListServiceSpecificationRef" + }, + "relatedParty": { + + "$ref": "#/definitions/ListRelatedPartyRef" + } + } + + }, + + "ServiceInventoryEvent": { + "description": "Structure for a service inventory event notification", + + + "required": [ + + "id", + "href", + "name", + "type", + "state", + "relatedParty" + ], + "type": "object", + "properties": { + "id": { + "description": "The Service Instance Id", + "type": "string" + }, + "href": { + "description": "A reference to the service inventory", + "type": "string" + }, + "name": { + "description": "The name of the Service Instance", + "type": "string" + }, + "type": { + "description": "The type of event, service-instance", + "type": "string" + }, + "state": { + "description": "The state of the service instance", + "type": "string" + }, + "relatedParty": { + + "$ref": "#/definitions/RelatedPartyRef" + } + } + + }, + + "Notification": { + "description": "Notification structure for a service notification", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + + "$ref": "#/definitions/eventType" + }, + "event": { + + "$ref": "#/definitions/ServiceInventoryEvent" + } + } + + } + } + } + \ No newline at end of file diff --git a/docs/offeredapis/api_serviceInventory/swagger.yaml b/docs/offeredapis/api_serviceInventory/swagger.yaml new file mode 100644 index 0000000..6550d5d --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/swagger.yaml @@ -0,0 +1,398 @@ +swagger: "2.0" +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.0_inProgress" + title: "API ServiceInventory" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "localhost:8080" +basePath: "/nbi/api/v4" +schemes: +- "http" +produces: +- "application/json;charset=utf-8" +tags: +- name: "Service" + description: "Provided by NBI" +- name: "Notification" + description: "provided by subscriber, which MUST has been registered by creating\ + \ a Hub ressource on NBI" +paths: + /service: + get: + tags: + - "Service" + produces: + - "application/json;charset=utf-8" + operationId: "serviceFind" + 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 + parameters: + - name: "relatedParty.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.name" + required: false + in: "query" + description: "" + type: "string" + - name: "id" + required: false + in: "query" + description: "" + type: "string" + - name: "fields" + required: false + in: "query" + description: "" + type: "string" + responses: + 200: + description: "Ok" + schema: + type: "array" + items: + $ref: "#/definitions/ListService" + /service/{id}: + get: + tags: + - "Service" + produces: + - "application/json;charset=utf-8" + operationId: "serviceGet" + summary: "Retrieve a service" + description: "This operation retrieves a service entity. \nAttribute selection\ + \ is enabled for all first level attributes." + deprecated: false + parameters: + - name: "id" + required: true + in: "path" + type: "string" + responses: + 200: + description: "Ok" + schema: + $ref: "#/definitions/Service" + /notification: + post: + tags: + - "Notification" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "notificationCreate" + summary: "NBI will send notification to this operation provided by subscribers" + description: "" + deprecated: false + parameters: + - name: "Notification" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/Notification" + responses: + 201: + description: "Created" + schema: + $ref: "#/definitions/Notification" +definitions: + eventType: + description: "" + type: "string" + enum: + - "ServiceCreationNotification" + - "ServiceAttributeValueChangeNotification" + - "ServiceRemoveNotification" + ErrorRepresentation: + description: "This class is used to describe error." + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user." + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceError: + description: "url pointing to documentation describing the error" + type: "string" + '@type': + description: "The class type of a REST resource." + type: "string" + '@schemaLocation': + description: "it provides a link to the schema describing a REST resource." + type: "string" + Service: + description: "Instantiated service (service_instance) in AAI" + type: "object" + properties: + id: + description: "Unique identifier of the service - Valued with service-instance-id" + type: "string" + href: + description: "Reference of the service\nNot managed in Beijing release" + type: "string" + name: + description: "Name of the service - Valued with service-instance-name" + type: "string" + type: + description: "Service type - valued with 'service-instance'" + type: "string" + state: + description: "State of the service." + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Not\ + \ used in Beijing release." + type: "string" + '@baseType': + description: "Not managed in Beijing release" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release" + type: "string" + serviceSpecification: + $ref: "#/definitions/ServiceSpecificationRef" + characteristic: + type: "array" + items: + $ref: "#/definitions/ServiceCharacteristic" + supportingResource: + type: "array" + items: + $ref: "#/definitions/SupportingResource" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedPartyRef" + ServiceSpecificationRef: + description: "Service specification reference: ServiceSpecification of this service\ + \ (catalog information)" + type: "object" + properties: + id: + description: "Unique identifier of the service specification. valued to model-version-id" + type: "string" + href: + description: "Reference of the service specification.\nnot managed in Beijing\ + \ release." + type: "string" + name: + description: "Name of the required service specification" + type: "string" + version: + description: "Service specification version.\nNot managed in Beijing release" + type: "string" + '@referredType': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPservice'. We used this features to add following attribute:\ + \ invariantUUID" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release" + type: "string" + invariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - model-invariant-id" + type: "string" + ServiceCharacteristic: + description: "A list of name value pairs that define the service characteristics\n\ + Not managed in Beijing release." + required: + - "name" + type: "object" + properties: + name: + description: "Name of the characteristic\nNot managed in Beijing release." + type: "string" + valueType: + description: "Type of value for this characteristic.\nNot managed in Beijing\ + \ release." + type: "string" + value: + $ref: "#/definitions/Value" + SupportingResource: + description: "Supporting resource - A supportingResource will be retrieved for\ + \ each relationship of the relationship-list where related-link describe a vnf" + type: "object" + properties: + id: + description: "Unique identifier of the supporting resource - Valued to vnf-id" + type: "string" + href: + description: "Reference of the supporting resource" + type: "string" + role: + description: "Not managed in Beijing release." + type: "string" + name: + description: "Name of the supporting resource - Valued with vnf_-name" + type: "string" + '@referredType': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAP resource'. We used this features to add following attributes:\n\ + \ status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release." + type: "string" + status: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with prov-status" + type: "string" + modelInvariantId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-invariant-id" + type: "string" + modelVersionId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-verson-id" + type: "string" + modelCustomisationId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-customisation-id" + type: "string" + RelatedPartyRef: + description: "RelatedParty reference. A related party defines party or party role\ + \ linked to a specific entity." + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + href: + description: "Reference of a related party.\nNot filled in Beijing release." + type: "string" + role: + description: "Role played by the related party.\nFilled with 'ONAPcustomer'" + type: "string" + '@referredType': + description: "Not managed in the Beijing release." + type: "string" + Value: + description: "Structure used to describe characteristic value.\nNot managed in\ + \ Beijing release." + type: "object" + properties: + '@type': + description: "Not managed in Beijing release." + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release." + type: "string" + serviceCharacteristicValue: + description: "Not managed in Beijing release." + type: "string" + ListRelatedPartyRef: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + role: + description: "Role played by the related party - only role “ONAPcustomer”\ + \ is managed in Beijing release." + type: "string" + ListServiceSpecificationRef: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of the service specification" + type: "string" + name: + description: "Name of the required service specification" + type: "string" + ListService: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of the service" + type: "string" + name: + description: "Name of the service" + type: "string" + serviceSpecification: + $ref: "#/definitions/ListServiceSpecificationRef" + relatedParty: + $ref: "#/definitions/ListRelatedPartyRef" + ServiceInventoryEvent: + description: "Structure for a service inventory event notification" + required: + - "id" + - "href" + - "name" + - "type" + - "state" + - "relatedParty" + type: "object" + properties: + id: + description: "The Service Instance Id" + type: "string" + href: + description: "A reference to the service inventory" + type: "string" + name: + description: "The name of the Service Instance" + type: "string" + type: + description: "The type of event, service-instance" + type: "string" + state: + description: "The state of the service instance" + type: "string" + relatedParty: + $ref: "#/definitions/RelatedPartyRef" + Notification: + description: "Notification structure for a service notification" + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + $ref: "#/definitions/eventType" + event: + $ref: "#/definitions/ServiceInventoryEvent" diff --git a/docs/offeredapis/api_serviceOrder/api.plantuml b/docs/offeredapis/api_serviceOrder/api.plantuml new file mode 100644 index 0000000..c13c0c5 --- /dev/null +++ b/docs/offeredapis/api_serviceOrder/api.plantuml @@ -0,0 +1,205 @@ +@startuml + +enum ActionType { + add + modify + delete + noChange +} +enum StateType { + acknowledged + rejected + pending + held + inProgress + cancelled + completed + failed + partial +} +enum RelationshipType { + reliesOn +} +enum EventType { + ServiceOrderCreationNotification + ServiceOrderStateChangeNotification + ServiceOrderItemStateChangeNotification +} +enum SeverityMessage { + information + error +} + +class Error { + code:int + reason:string + message:string + status:string + referenceError:string +} + +class ServiceRelationship + ServiceRelationship --> "1-1" RelationshipType : type + ServiceRelationship --> "1-1" Service : service + +class ServiceRef { + id:string + href:string +} + +class ServiceCharacteristic { + name:string + valueType:string +} + ServiceCharacteristic --> "0-1" Value : value + +class RelatedParty { + id:string + href:string + role:string + name:string + @referredType:string +} + +class ServiceSpecificationRef { + id:string + href:string + name:string + version:string + @type:string + @schemaLocation:string + @baseType:string +} + ServiceSpecificationRef --> "0-1" TargetServiceSchema : targetServiceSchema + +class Service { + id:string + href:string + name:string + serviceState:string + @type:string + @schemaLocation:string +} + Service --> "0-*" ServiceCharacteristic : serviceCharacteristic + Service --> "0-*" ServiceRelationship : serviceRelationship + Service --> "0-*" RelatedParty : relatedParty + Service --> "0-1" ServiceSpecificationRef : serviceSpecification + +class OrderItemRelationship { + id:string +} + OrderItemRelationship --> "1-1" RelationshipType : type + +class ServiceOrderItem { + id:string + percentProgress:string + @type:string + @schemaLocation:string + @baseType:string +} + ServiceOrderItem --> "0-1" ActionType : action + ServiceOrderItem --> "0-1" StateType : state + ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship + ServiceOrderItem --> "1-1" Service : service + ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage + +class ServiceOrder { + id:string + href:string + externalId:string + priority:string + description:string + category:string + orderDate:dateTime + completionDateTime:dateTime + requestedStartDate:dateTime + requestedCompletionDate:dateTime + expectedCompletionDate:dateTime + startDate:dateTime + @baseType:string + @type:string + @schemaLocation:string +} + ServiceOrder --> "0-1" StateType : state + ServiceOrder --> "0-*" RelatedParty : relatedParty + ServiceOrder --> "0-*" OrderRelationship : orderRelationship + ServiceOrder --> "0-*" ServiceOrderItem : orderItem + ServiceOrder --> "0-*" OrderMessage : orderMessage + +class OrderRelationship { + type:string + id:string + href:string + @referredType:string +} + +class TargetServiceSchema { + @type:string + @schemaLocation:string +} + +class Value { + serviceCharacteristicValue:string +} + +class CreateServiceOrderItem { + id:string +} + CreateServiceOrderItem --> "0-1" ActionType : action + CreateServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship + CreateServiceOrderItem --> "1-1" Service : service + +class CreateServiceOrder { + externalId:string + priority:string + description:string + category:string + requestedStartDate:dateTime + requestedCompletionDate:dateTime +} + CreateServiceOrder --> "0-*" RelatedParty : relatedParty + CreateServiceOrder --> "0-*" OrderRelationship : orderRelationship + CreateServiceOrder --> "0-*" CreateServiceOrderItem : orderItem + +class ServiceOrderSummary { + id:string + href:string + externalId:string + orderDate:dateTime + completionDateTime:dateTime +} + ServiceOrderSummary --> "0-1" StateType : state + +class Notification { + eventId:string + eventDate:dateTime +} + Notification --> "1-1" EventType : eventType + Notification --> "1-1" ServiceOrderSummaryWithItem : event + +class ServiceOrderItemSummary { + id:string +} + ServiceOrderItemSummary --> "0-1" ActionType : action + ServiceOrderItemSummary --> "0-1" StateType : state + ServiceOrderItemSummary --> "1-1" Service : service + +class ServiceOrderSummaryWithItem { + id:string + href:string + externalId:string + orderDate:dateTime + completionDateTime:dateTime +} + ServiceOrderSummaryWithItem --> "0-1" StateType : state + ServiceOrderSummaryWithItem --> "0-*" ServiceOrderItemSummary : orderItem + +class OrderMessage { + code:string + field:string + messageInformation:string + correctionRequired:boolean +} + OrderMessage --> "1-1" SeverityMessage : severity + +@enduml \ No newline at end of file diff --git a/docs/offeredapis/api_serviceOrder/model.xsd b/docs/offeredapis/api_serviceOrder/model.xsd new file mode 100644 index 0000000..6f8f207 --- /dev/null +++ b/docs/offeredapis/api_serviceOrder/model.xsd @@ -0,0 +1,932 @@ + + + + API Designer + Model: serviceOrder + Version: 4.0.0_inProgress + Owner: ONAPNBI + Generated on: 2019-03-12T16:45:40.663Z + Generated by: Orange API Designer v2, model-v1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Application related code (as defined in the API or from a common list) + + + + + Text that explains the reason for error. This can be shown to a client user. + + + + + Text that provide more details and corrective actions related to the error. This can be shown to a client user + + + + + http error code extension like 400-2 + + + + + url pointing to documentation describing the error + + + + + + + Linked Services to the one instantiate +nbi component used this relationship to sort request to ONAP. + + + + + Linked Services to the one instantiate +nbi component used this relationship to sort request to ONAP. + + + + + Relationship type. It can be : “reliesOn” if the Service needs another already owned Service to rely on (e.g. an option on an already owned mobile access Service) or “targets” or “isTargeted” (depending on the way of expressing the link) for any other kind of links that may be useful. +Only reliesOn is managed in Beijing release. + + + + + Service reference - id of the service targeted. +not managed in Beijing release. + + + + + + + Service references + + + + + Service references + + + + + Unique identifier of the service + + + + + Reference of the service + + + + + + + ServiceCharacteristic + + + + + ServiceCharacteristic + + + + + Name of characteristic + + + + + + + + + + + + + A related party defines party which are involved in this order and the role they are playing. +for Beijing release: +With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information: +o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not. +o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists. + + + + + A related party defines party which are involved in this order and the role they are playing. +for Beijing release: +With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information: +o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not. +o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists. + + + + + Unique identifier of a related party + + + + + An hyperlink to the party - not used in Beijnig release + + + + + The role of the related party (e.g. Owner, requester, fullfiller etc). +ONLY 'ONAPcustomer' is considered + + + + + Name of the related party + + + + + + + + + + + + The service specification (these attributes are fetched from the catalogue). + + + + + The service specification (these attributes are fetched from the catalogue). + + + + + Unique identifier of the service specification +This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request. + + + + + Reference of the service specification +Not used in Beijing release. + + + + + Name of the service specification +Not used in Beijing release + + + + + Version of the service Specification +Not used in Beijing release + + + + + This structure could be used to describe the service + + + + + Not used in Beijing release + + + + + Not used in Beijing release + + + + + Not used in Beijing release + + + + + + + Service (to be added, modified, deleted) description + + + + + Service (to be added, modified, deleted) description + + + + + Identifier of a service instance. +It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id + + + + + Reference to the Service (useful for delete or modify command). +Not managed in Beijing release. + + + + + Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName. + + + + + The lifecycle state of the service requested; +Not managed in Beijing release. + + + + + To define the service type +Not managed in Beijing Release + + + + + The URL to get the resource schema. +Not managed in Beijing Release + + + + + A list of service characteristics .A name/value pair list used to store instance specific values of attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of "name" can exist + + + + + A list or service relationships (ServiceRelationship[*]). Linked Services to the one instantiate, it can be : “reliesOn” if the Service needs another already owned Service to rely on (e.g. an option on an already owned mobile access Service) or “targets” or “isTargeted” (depending on the way of expressing the link) for any other kind of links that may be useful. +Only reliesOn are considered in Beijnig release. + + + + + A list of related party parties linked at the Service level (it may be a User for example). +Not managed in Beijing release + + + + + A link to the service specification (catalog information) +This is required if orderItem action is add. + + + + + + + Linked order item to the one containing this attribute. +nbi component used this relationship to sort request to ONAP. + + + + + Linked order item to the one containing this attribute. +nbi component used this relationship to sort request to ONAP. + + + + + The type of related order item, can be : dependancy if the order item needs to be “not started” until another order item is complete + + + + + Unique identifier of an order item + + + + + + + An identified part of the order. A service order is decomposed into one or more order items. + + + + + An identified part of the order. A service order is decomposed into one or more order items. + + + + + Identifier of the line item (generally it is a sequence number 01, 02, 03, …) + + + + + The action to be carried out on the Service. Can be add, modify, delete, noChange + + + + + State of the order item (described in the state machine diagram) +Only Acknowledged, Rejected, InProgress, Completed, Failed will be managed for service order item state + + + + + Progress of the delivery in percentage. + + + + + Used to extend the order item. +not used in Beijing relase + + + + + not used in Beijing relase + + + + + not used in Beijing relase + + + + + Linked order item to the one containing this attribute + + + + + The Service to be acted on by the order item + + + + + + + + + + + + A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa + + + + + A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa + + + + + ID created on repository side + + + + + Hyperlink to access the order + + + + + ID given by the consumer and only understandable by him (to facilitate his searches) + + + + + A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest) + + + + + A free-text description of the service order + + + + + Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...) + + + + + State of the order : described in the state-machine diagram +Only Acknowledged, Rejected, InProgress, Completed, Failed, Partial will be managed for service order state (Held, Pending and Cancelled are not managed) + + + + + + + + + + Date when the order was completed + + + + + Order start date wished by the requestor + + + + + Requested delivery date from the requestor perspective + + + + + + + + + + Date when the order was started for processing + + + + + + + + + + + + + + + + + + + + A list of related parties which are involved in this order and the role they are playing. + + + + + A list of related order references .Linked order to the one containing this attribute + + + + + A list of order items that have to be processed. + + + + + + + + Linked order to the one containing this attribute. +This relationship is not used to sort ONAP request. + + + + + Linked order to the one containing this attribute. +This relationship is not used to sort ONAP request. + + + + + The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder) + + + + + The id of the related order + + + + + A hyperlink to the related order + + + + + Type of the referred order. + + + + + + + Target to the schema describing the service spec resource + + + + + Target to the schema describing the service spec resource + + + + + Indicates the (class) type of resource. + + + + + This field provided a link to the schema describing this REST resource. + + + + + + + Value is a descriptive structure for service characteristic + + + + + Value is a descriptive structure for service characteristic + + + + + Value of the characteristic. + + + + + + + This structure is used in the operation POST for a serviceOrder request to describe an item. +Attribute description is not accurate and should be find in the serviceOrderItem class. + + + + + This structure is used in the operation POST for a serviceOrder request to describe an item. +Attribute description is not accurate and should be find in the serviceOrderItem class. + + + + + Identifier of the line item (generally it is a sequence number 01, 02, 03, …) + + + + + The action to be carried out on the Service. Can be add, modify, delete, noChange + + + + + Linked order item to the one containing this attribute + + + + + The Service to be acted on by the order item + + + + + + + This structure is used in the operation POST for a serviceOrder request. +Attribute description is not accurate and should be find in the serviceOrder class. + + + + + This structure is used in the operation POST for a serviceOrder request. +Attribute description is not accurate and should be find in the serviceOrder class. + + + + + ID given by the consumer and only understandable by him (to facilitate his searches) + + + + + A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest) + + + + + A free-text description of the service order + + + + + Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...) + + + + + Order start date wished by the requestor + + + + + Requested delivery date from the requestor perspective + + + + + A list of related parties which are involved in this order and the role they are playing. + + + + + A list of related order references .Linked order to the one containing this attribute + + + + + A list of order items that have to be processed. + + + + + + + This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages + + + + + This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages + + + + + ID created on repository side + + + + + Hyperlink to access the order + + + + + ID given by the consumer and only understandable by him (to facilitate his searches) + + + + + State of the order : described in the state-machine diagram +Only Acknowledged, Rejected, InProgress, Completed, Failed, Partial will be managed for service order state (Held, Pending and Cancelled are not managed) + + + + + + + + + + Date when the order was completed + + + + + + + Notification structure for a serviceOrdering notification + + + + + Notification structure for a serviceOrdering notification + + + + + + + + + + + + + + + + + + + + + + + Service Order item summary to be used for notification + + + + + Service Order item summary to be used for notification + + + + + Identifier of the line item (generally it is a sequence number 01, 02, 03, …) + + + + + The action to be carried out on the Service. Can be add, modify, delete, noChange +modify is not managed in Beijing release. + + + + + State of the order item (described in the state machine diagram) +Only Acknowledged, Rejected, InProgress, Completed, Failed will be managed for service order item state + + + + + The Service to be acted on by the order item + + + + + + + Service order item summary with item description + + + + + Service order item summary with item description + + + + + ID created on repository side + + + + + Hyperlink to access the order + + + + + ID given by the consumer and only understandable by him (to facilitate his searches) + + + + + State of the order : described in the state-machine diagram +Only Acknowledged, Rejected, InProgress, Completed, Failed, Partial will be managed for service order state (Held, Pending and Cancelled are not managed) + + + + + + + + + + Date when the order was completed + + + + + A list of order items that have to be processed. + + + + + + + An optional array of messages associated with the Order + + + + + An optional array of messages associated with the Order + + + + + A code associated to this message + + + + + Service Order attribute related to this error message + + + + + Message related to this order + + + + + Gravity of this message + + + + + Indicator that an action is required to allow service order fullfilment to follow up + + + + + diff --git a/docs/offeredapis/api_serviceOrder/swagger.json b/docs/offeredapis/api_serviceOrder/swagger.json new file mode 100644 index 0000000..8d424c7 --- /dev/null +++ b/docs/offeredapis/api_serviceOrder/swagger.json @@ -0,0 +1,1110 @@ + + { + "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", + "version": "4.0.0_inProgress", + "title": "API ServiceOrder", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "localhost:8080", + "basePath": "/nbi/api/v4", + "schemes": [ + "http" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "ServiceOrder", + "description": "provided by NBI" + }, + { + "name": "Notification", + "description": "provided by subscribers, which MUST registered by creating a hub resource" + } + ], + "paths": { + "/serviceOrder": { + "post": { + "tags": [ + "ServiceOrder" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceOrderCreate", + "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, + + "parameters": [ + + { + "name": "serviceOrder", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/CreateServiceOrder" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ServiceOrder" + } + + } + } + }, + "get": { + "tags": [ + "ServiceOrder" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceOrderFind", + "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, + + "parameters": [ + + { + "name": "externalId", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "state", + "required": false, + "in": "query", + "description": "state of the order(s) to be retrieved", + + "type": "string" + }, + { + "name": "description", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "orderDate.gt", + "required": false, + "in": "query", + "description": "order date greather than", + + "type": "string" + }, + { + "name": "orderDate.lt", + "required": false, + "in": "query", + "description": "order date lower than", + + "type": "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "this attribute could be used to filter retrieved attribute(s) and/or sort SO.", + + "type": "string" + }, + { + "name": "offset", + "required": false, + "in": "query", + "description": "The index of the first element to retrieve. Zero is the first element of the collection.", + + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "required": false, + "in": "query", + "description": "The maximum number of elements to retrieve (it can be greater than the actual available number of items).", + + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceOrder" + } + }, + "headers": { + "X-Total-Count": { + "description": "", + "type": "integer", + "format": "int32" + }, + "X-Result-Count": { + "description": "", + "type": "integer", + "format": "int32" + } + } + + } + } + } + }, + "/serviceOrder/{id}": { + "get": { + "tags": [ + "ServiceOrder" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceOrderGet", + "summary": "Retrieve a service order", + "description": "This operation retrieves a service order entity. \nAttribute selection is enabled for all first level attributes.", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "required": true, + "in": "path", + "type" : "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "Attribute selection", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ServiceOrder" + } + + } + } + } + }, + "/notification": { + "post": { + "tags": [ + "Notification" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "notificationCreate", + "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, + + "parameters": [ + + { + "name": "Notification", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/Notification" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Notification" + } + + } + } + } + } + }, + "definitions": { + + "ActionType": { + "description": "Action type to be describer on the order item.\nmodify is not managed in Beijing release", + + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange"] + + }, + "StateType": { + "description": "List of possible state for the order and the orderItem.", + + "type": "string", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial"] + + }, + "RelationshipType": { + "description": "Relationship type;\nOnly reliesOn is managed in Beijing release.", + + "type": "string", + "enum": [ + "reliesOn"] + + }, + "EventType": { + "description": "", + + "type": "string", + "enum": [ + "ServiceOrderCreationNotification", + "ServiceOrderStateChangeNotification", + "ServiceOrderItemStateChangeNotification"] + + }, + "SeverityMessage": { + "description": "", + + "type": "string", + "enum": [ + "information", + "error"] + + }, + + "Error": { + "description": "", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceError": { + "description": "url pointing to documentation describing the error", + "type": "string" + } + } + + }, + + "ServiceRelationship": { + "description": "Linked Services to the one instantiate\nnbi component used this relationship to sort request to ONAP.", + + + "required": [ + + "type", + "service" + ], + "type": "object", + "properties": { + "type": { + + "$ref": "#/definitions/RelationshipType" + }, + "service": { + + "$ref": "#/definitions/Service" + } + } + + }, + + "ServiceRef": { + "description": "Service references", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "href": { + "description": "Reference of the service", + "type": "string" + } + } + + }, + + "ServiceCharacteristic": { + "description": "ServiceCharacteristic", + + + "required": [ + + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of characteristic", + "type": "string" + }, + "valueType": { + "description": "", + "type": "string" + }, + "value": { + + "$ref": "#/definitions/Value" + } + } + + }, + + "RelatedParty": { + "description": "A related party defines party which are involved in this order and the role they are playing.\nfor Beijing release:\nWith the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.\no\tIf no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.", + + + "required": [ + + "id", + "role" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "href": { + "description": "An hyperlink to the party - not used in Beijnig release", + "type": "string" + }, + "role": { + "description": "The role of the related party (e.g. Owner, requester, fullfiller etc).\nONLY 'ONAPcustomer' is considered", + "type": "string" + }, + "name": { + "description": "Name of the related party", + "type": "string" + }, + "@referredType": { + "description": "", + "type": "string" + } + } + + }, + + "ServiceSpecificationRef": { + "description": "The service specification (these attributes are fetched from the catalogue).", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification\nThis information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.", + "type": "string" + }, + "href": { + "description": "Reference of the service specification\nNot used in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the service specification\nNot used in Beijing release", + "type": "string" + }, + "version": { + "description": "Version of the service Specification\nNot used in Beijing release", + "type": "string" + }, + "targetServiceSchema": { + + "$ref": "#/definitions/TargetServiceSchema" + }, + "@type": { + "description": "Not used in Beijing release", + "type": "string" + }, + "@schemaLocation": { + "description": "Not used in Beijing release", + "type": "string" + }, + "@baseType": { + "description": "Not used in Beijing release", + "type": "string" + } + } + + }, + + "Service": { + "description": "Service (to be added, modified, deleted) description", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of a service instance.\nIt must be valued if orderItem action is 'delete' and corresponds to a AAI service.id", + "type": "string" + }, + "href": { + "description": "Reference to the Service (useful for delete or modify command).\nNot managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.", + "type": "string" + }, + "serviceState": { + "description": "The lifecycle state of the service requested;\nNot managed in Beijing release.", + "type": "string" + }, + "@type": { + "description": "To define the service type\nNot managed in Beijing Release", + "type": "string" + }, + "@schemaLocation": { + "description": "The URL to get the resource schema.\nNot managed in Beijing Release", + "type": "string" + }, + "serviceCharacteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCharacteristic" + } + }, + "serviceRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceRelationship" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedParty" + } + }, + "serviceSpecification": { + + "$ref": "#/definitions/ServiceSpecificationRef" + } + } + + }, + + "OrderItemRelationship": { + "description": "Linked order item to the one containing this attribute.\nnbi component used this relationship to sort request to ONAP.", + + + "required": [ + + "type", + "id" + ], + "type": "object", + "properties": { + "type": { + + "$ref": "#/definitions/RelationshipType" + }, + "id": { + "description": "Unique identifier of an order item", + "type": "string" + } + } + + }, + + "ServiceOrderItem": { + "description": "An identified part of the order. A service order is decomposed into one or more order items.", + + + "required": [ + + "id", + "service" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", + "type": "string" + }, + "action": { + + "$ref": "#/definitions/ActionType" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "percentProgress": { + "description": "Progress of the delivery in percentage.", + "type": "string" + }, + "@type": { + "description": "Used to extend the order item.\nnot used in Beijing relase", + "type": "string" + }, + "@schemaLocation": { + "description": "not used in Beijing relase", + "type": "string" + }, + "@baseType": { + "description": "not used in Beijing relase", + "type": "string" + }, + "orderItemRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderItemRelationship" + } + }, + "service": { + + "$ref": "#/definitions/Service" + }, + "orderItemMessage": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderMessage" + } + } + } + + }, + + "ServiceOrder": { + "description": "A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "ID created on repository side", + "type": "string" + }, + "href": { + "description": "Hyperlink to access the order", + "type": "string" + }, + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "priority": { + "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", + "type": "string" + }, + "description": { + "description": "A free-text description of the service order", + "type": "string" + }, + "category": { + "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", + "type": "string" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "orderDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "completionDateTime": { + "description": "Date when the order was completed", + "type": "string", + "format": "date-time" + }, + "requestedStartDate": { + "description": "Order start date wished by the requestor", + "type": "string", + "format": "date-time" + }, + "requestedCompletionDate": { + "description": "Requested delivery date from the requestor perspective", + "type": "string", + "format": "date-time" + }, + "expectedCompletionDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "startDate": { + "description": "Date when the order was started for processing", + "type": "string", + "format": "date-time" + }, + "@baseType": { + "description": "", + "type": "string" + }, + "@type": { + "description": "", + "type": "string" + }, + "@schemaLocation": { + "description": "", + "type": "string" + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedParty" + } + }, + "orderRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderRelationship" + } + }, + "orderItem": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceOrderItem" + } + }, + "orderMessage": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderMessage" + } + } + } + + }, + + "OrderRelationship": { + "description": "Linked order to the one containing this attribute.\nThis relationship is not used to sort ONAP request.", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)", + "type": "string" + }, + "id": { + "description": "The id of the related order", + "type": "string" + }, + "href": { + "description": "A hyperlink to the related order", + "type": "string" + }, + "@referredType": { + "description": "Type of the referred order.", + "type": "string" + } + } + + }, + + "TargetServiceSchema": { + "description": "Target to the schema describing the service spec resource", + + + "required": [ + + "@type", + "@schemaLocation" + ], + "type": "object", + "properties": { + "@type": { + "description": "Indicates the (class) type of resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "This field provided a link to the schema describing this REST resource.", + "type": "string" + } + } + + }, + + "Value": { + "description": "Value is a descriptive structure for service characteristic", + + + "type": "object", + "properties": { + "serviceCharacteristicValue": { + "description": "Value of the characteristic.", + "type": "string" + } + } + + }, + + "CreateServiceOrderItem": { + "description": "This structure is used in the operation POST for a serviceOrder request to describe an item.\nAttribute description is not accurate and should be find in the serviceOrderItem class.", + + + "required": [ + + "id", + "service" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", + "type": "string" + }, + "action": { + + "$ref": "#/definitions/ActionType" + }, + "orderItemRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderItemRelationship" + } + }, + "service": { + + "$ref": "#/definitions/Service" + } + } + + }, + + "CreateServiceOrder": { + "description": "This structure is used in the operation POST for a serviceOrder request.\nAttribute description is not accurate and should be find in the serviceOrder class.", + + + "type": "object", + "properties": { + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "priority": { + "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", + "type": "string" + }, + "description": { + "description": "A free-text description of the service order", + "type": "string" + }, + "category": { + "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", + "type": "string" + }, + "requestedStartDate": { + "description": "Order start date wished by the requestor", + "type": "string", + "format": "date-time" + }, + "requestedCompletionDate": { + "description": "Requested delivery date from the requestor perspective", + "type": "string", + "format": "date-time" + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedParty" + } + }, + "orderRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderRelationship" + } + }, + "orderItem": { + + "type": "array", + "items": { + "$ref": "#/definitions/CreateServiceOrderItem" + } + } + } + + }, + + "ServiceOrderSummary": { + "description": "This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "ID created on repository side", + "type": "string" + }, + "href": { + "description": "Hyperlink to access the order", + "type": "string" + }, + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "orderDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "completionDateTime": { + "description": "Date when the order was completed", + "type": "string", + "format": "date-time" + } + } + + }, + + "Notification": { + "description": "Notification structure for a serviceOrdering notification", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + + "$ref": "#/definitions/EventType" + }, + "event": { + + "$ref": "#/definitions/ServiceOrderSummaryWithItem" + } + } + + }, + + "ServiceOrderItemSummary": { + "description": "Service Order item summary to be used for notification", + + + "required": [ + + "id", + "service" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", + "type": "string" + }, + "action": { + + "$ref": "#/definitions/ActionType" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "service": { + + "$ref": "#/definitions/Service" + } + } + + }, + + "ServiceOrderSummaryWithItem": { + "description": "Service order item summary with item description", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "ID created on repository side", + "type": "string" + }, + "href": { + "description": "Hyperlink to access the order", + "type": "string" + }, + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "orderDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "completionDateTime": { + "description": "Date when the order was completed", + "type": "string", + "format": "date-time" + }, + "orderItem": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceOrderItemSummary" + } + } + } + + }, + + "OrderMessage": { + "description": "An optional array of messages associated with the Order", + + + "required": [ + + "severity", + "correctionRequired" + ], + "type": "object", + "properties": { + "code": { + "description": "A code associated to this message", + "type": "string" + }, + "field": { + "description": "Service Order attribute related to this error message", + "type": "string" + }, + "messageInformation": { + "description": "Message related to this order", + "type": "string" + }, + "severity": { + + "$ref": "#/definitions/SeverityMessage" + }, + "correctionRequired": { + "description": "Indicator that an action is required to allow service order fullfilment to follow up", + "type": "boolean" + } + } + + } + } + } + \ No newline at end of file diff --git a/docs/offeredapis/api_serviceOrder/swagger.yaml b/docs/offeredapis/api_serviceOrder/swagger.yaml new file mode 100644 index 0000000..36d8e87 --- /dev/null +++ b/docs/offeredapis/api_serviceOrder/swagger.yaml @@ -0,0 +1,784 @@ +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" + version: "4.0.0_inProgress" + title: "API ServiceOrder" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "localhost:8080" +basePath: "/nbi/api/v4" +schemes: +- "http" +produces: +- "application/json;charset=utf-8" +tags: +- name: "ServiceOrder" + description: "provided by NBI" +- name: "Notification" + description: "provided by subscribers, which MUST registered by creating a hub resource" +paths: + /serviceOrder: + post: + tags: + - "ServiceOrder" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "serviceOrderCreate" + 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 + parameters: + - name: "serviceOrder" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/CreateServiceOrder" + responses: + 201: + description: "Created" + schema: + $ref: "#/definitions/ServiceOrder" + get: + tags: + - "ServiceOrder" + produces: + - "application/json;charset=utf-8" + operationId: "serviceOrderFind" + 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\ + \ be described in the fields attribute." + deprecated: false + parameters: + - name: "externalId" + required: false + in: "query" + description: "" + type: "string" + - name: "state" + required: false + in: "query" + description: "state of the order(s) to be retrieved" + type: "string" + - name: "description" + required: false + in: "query" + description: "" + type: "string" + - name: "orderDate.gt" + required: false + in: "query" + description: "order date greather than" + type: "string" + - name: "orderDate.lt" + required: false + in: "query" + description: "order date lower than" + type: "string" + - name: "fields" + required: false + in: "query" + description: "this attribute could be used to filter retrieved attribute(s)\ + \ and/or sort SO." + type: "string" + - name: "offset" + required: false + in: "query" + description: "The index of the first element to retrieve. Zero is the first\ + \ element of the collection." + type: "integer" + format: "int32" + - name: "limit" + required: false + in: "query" + description: "The maximum number of elements to retrieve (it can be greater\ + \ than the actual available number of items)." + type: "integer" + format: "int32" + responses: + 200: + description: "Ok" + schema: + type: "array" + items: + $ref: "#/definitions/ServiceOrder" + headers: + X-Total-Count: + description: "" + type: "integer" + format: "int32" + X-Result-Count: + description: "" + type: "integer" + format: "int32" + /serviceOrder/{id}: + get: + tags: + - "ServiceOrder" + produces: + - "application/json;charset=utf-8" + operationId: "serviceOrderGet" + summary: "Retrieve a service order" + description: "This operation retrieves a service order entity. \nAttribute selection\ + \ is enabled for all first level attributes." + deprecated: false + parameters: + - name: "id" + required: true + in: "path" + type: "string" + - name: "fields" + required: false + in: "query" + description: "Attribute selection" + type: "string" + responses: + 200: + description: "Ok" + schema: + $ref: "#/definitions/ServiceOrder" + /notification: + post: + tags: + - "Notification" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "notificationCreate" + 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 + parameters: + - name: "Notification" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/Notification" + responses: + 201: + description: "Created" + schema: + $ref: "#/definitions/Notification" +definitions: + ActionType: + description: "Action type to be describer on the order item.\nmodify is not managed\ + \ in Beijing release" + type: "string" + enum: + - "add" + - "modify" + - "delete" + - "noChange" + StateType: + description: "List of possible state for the order and the orderItem." + type: "string" + enum: + - "acknowledged" + - "rejected" + - "pending" + - "held" + - "inProgress" + - "cancelled" + - "completed" + - "failed" + - "partial" + RelationshipType: + description: "Relationship type;\nOnly reliesOn is managed in Beijing release." + type: "string" + enum: + - "reliesOn" + EventType: + description: "" + type: "string" + enum: + - "ServiceOrderCreationNotification" + - "ServiceOrderStateChangeNotification" + - "ServiceOrderItemStateChangeNotification" + SeverityMessage: + description: "" + type: "string" + enum: + - "information" + - "error" + Error: + description: "" + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user" + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceError: + description: "url pointing to documentation describing the error" + type: "string" + ServiceRelationship: + description: "Linked Services to the one instantiate\nnbi component used this\ + \ relationship to sort request to ONAP." + required: + - "type" + - "service" + type: "object" + properties: + type: + $ref: "#/definitions/RelationshipType" + service: + $ref: "#/definitions/Service" + ServiceRef: + description: "Service references" + required: + - "id" + type: "object" + properties: + id: + description: "Unique identifier of the service" + type: "string" + href: + description: "Reference of the service" + type: "string" + ServiceCharacteristic: + description: "ServiceCharacteristic" + required: + - "name" + type: "object" + properties: + name: + description: "Name of characteristic" + type: "string" + valueType: + description: "" + type: "string" + value: + $ref: "#/definitions/Value" + RelatedParty: + description: "A related party defines party which are involved in this order and\ + \ the role they are playing.\nfor Beijing release:\nWith the current version\ + \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\ + \ concept is confusing with Customer BSS concept. We took the following rules\ + \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\ + \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\ + \ in the serviceOrder header (we will not consider in this release the party\ + \ at item level); External API component will check if this customer exists\ + \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\ + \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\ + generic’ customer always exists." + required: + - "id" + - "role" + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + href: + description: "An hyperlink to the party - not used in Beijnig release" + type: "string" + role: + description: "The role of the related party (e.g. Owner, requester, fullfiller\ + \ etc).\nONLY 'ONAPcustomer' is considered" + type: "string" + name: + description: "Name of the related party" + type: "string" + '@referredType': + description: "" + type: "string" + ServiceSpecificationRef: + description: "The service specification (these attributes are fetched from the\ + \ catalogue)." + required: + - "id" + type: "object" + properties: + id: + description: "Unique identifier of the service specification\nThis information\ + \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\ + \ the request." + type: "string" + href: + description: "Reference of the service specification\nNot used in Beijing\ + \ release." + type: "string" + name: + description: "Name of the service specification\nNot used in Beijing release" + type: "string" + version: + description: "Version of the service Specification\nNot used in Beijing release" + type: "string" + targetServiceSchema: + $ref: "#/definitions/TargetServiceSchema" + '@type': + description: "Not used in Beijing release" + type: "string" + '@schemaLocation': + description: "Not used in Beijing release" + type: "string" + '@baseType': + description: "Not used in Beijing release" + type: "string" + Service: + description: "Service (to be added, modified, deleted) description" + required: + - "id" + type: "object" + properties: + id: + description: "Identifier of a service instance.\nIt must be valued if orderItem\ + \ action is 'delete' and corresponds to a AAI service.id" + type: "string" + href: + description: "Reference to the Service (useful for delete or modify command).\n\ + Not managed in Beijing release." + type: "string" + name: + description: "Name of the service - When orderItem action is 'add' this name\ + \ will be used in ONAP/SO request as InstaceName." + type: "string" + serviceState: + description: "The lifecycle state of the service requested;\nNot managed in\ + \ Beijing release." + type: "string" + '@type': + description: "To define the service type\nNot managed in Beijing Release" + type: "string" + '@schemaLocation': + description: "The URL to get the resource schema.\nNot managed in Beijing\ + \ Release" + type: "string" + serviceCharacteristic: + type: "array" + items: + $ref: "#/definitions/ServiceCharacteristic" + serviceRelationship: + type: "array" + items: + $ref: "#/definitions/ServiceRelationship" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedParty" + serviceSpecification: + $ref: "#/definitions/ServiceSpecificationRef" + OrderItemRelationship: + description: "Linked order item to the one containing this attribute.\nnbi component\ + \ used this relationship to sort request to ONAP." + required: + - "type" + - "id" + type: "object" + properties: + type: + $ref: "#/definitions/RelationshipType" + id: + description: "Unique identifier of an order item" + type: "string" + ServiceOrderItem: + description: "An identified part of the order. A service order is decomposed into\ + \ one or more order items." + required: + - "id" + - "service" + type: "object" + properties: + id: + description: "Identifier of the line item (generally it is a sequence number\ + \ 01, 02, 03, …)" + type: "string" + action: + $ref: "#/definitions/ActionType" + state: + $ref: "#/definitions/StateType" + percentProgress: + description: "Progress of the delivery in percentage." + type: "string" + '@type': + description: "Used to extend the order item.\nnot used in Beijing relase" + type: "string" + '@schemaLocation': + description: "not used in Beijing relase" + type: "string" + '@baseType': + description: "not used in Beijing relase" + type: "string" + orderItemRelationship: + type: "array" + items: + $ref: "#/definitions/OrderItemRelationship" + service: + $ref: "#/definitions/Service" + orderItemMessage: + type: "array" + items: + $ref: "#/definitions/OrderMessage" + ServiceOrder: + description: "A Service Order is a type of order which can be used to place an\ + \ order between a customer and a service provider or between a service provider\ + \ and a partner and vice versa" + required: + - "id" + type: "object" + properties: + id: + description: "ID created on repository side" + type: "string" + href: + description: "Hyperlink to access the order" + type: "string" + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + priority: + description: "A way that can be used by consumers to prioritize orders in\ + \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ + \ and 4 the lowest)" + type: "string" + description: + description: "A free-text description of the service order" + type: "string" + category: + description: "Used to categorize the order that can be useful for the OM system\ + \ (e.g. “broadband”, “TVOption”, ...)" + type: "string" + state: + $ref: "#/definitions/StateType" + orderDate: + description: "" + type: "string" + format: "date-time" + completionDateTime: + description: "Date when the order was completed" + type: "string" + format: "date-time" + requestedStartDate: + description: "Order start date wished by the requestor" + type: "string" + format: "date-time" + requestedCompletionDate: + description: "Requested delivery date from the requestor perspective" + type: "string" + format: "date-time" + expectedCompletionDate: + description: "" + type: "string" + format: "date-time" + startDate: + description: "Date when the order was started for processing" + type: "string" + format: "date-time" + '@baseType': + description: "" + type: "string" + '@type': + description: "" + type: "string" + '@schemaLocation': + description: "" + type: "string" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedParty" + orderRelationship: + type: "array" + items: + $ref: "#/definitions/OrderRelationship" + orderItem: + type: "array" + items: + $ref: "#/definitions/ServiceOrderItem" + orderMessage: + type: "array" + items: + $ref: "#/definitions/OrderMessage" + OrderRelationship: + description: "Linked order to the one containing this attribute.\nThis relationship\ + \ is not used to sort ONAP request." + required: + - "id" + type: "object" + properties: + type: + description: "The type of related order, can be : “dependency” if the order\ + \ needs to be “not started” until another order item is complete (a service\ + \ order in this case) or “cross-ref” to keep track of the source order (a\ + \ productOrder)" + type: "string" + id: + description: "The id of the related order" + type: "string" + href: + description: "A hyperlink to the related order" + type: "string" + '@referredType': + description: "Type of the referred order." + type: "string" + TargetServiceSchema: + description: "Target to the schema describing the service spec resource" + required: + - "@type" + - "@schemaLocation" + type: "object" + properties: + '@type': + description: "Indicates the (class) type of resource." + type: "string" + '@schemaLocation': + description: "This field provided a link to the schema describing this REST\ + \ resource." + type: "string" + Value: + description: "Value is a descriptive structure for service characteristic" + type: "object" + properties: + serviceCharacteristicValue: + description: "Value of the characteristic." + type: "string" + CreateServiceOrderItem: + description: "This structure is used in the operation POST for a serviceOrder\ + \ request to describe an item.\nAttribute description is not accurate and should\ + \ be find in the serviceOrderItem class." + required: + - "id" + - "service" + type: "object" + properties: + id: + description: "Identifier of the line item (generally it is a sequence number\ + \ 01, 02, 03, …)" + type: "string" + action: + $ref: "#/definitions/ActionType" + orderItemRelationship: + type: "array" + items: + $ref: "#/definitions/OrderItemRelationship" + service: + $ref: "#/definitions/Service" + CreateServiceOrder: + description: "This structure is used in the operation POST for a serviceOrder\ + \ request.\nAttribute description is not accurate and should be find in the\ + \ serviceOrder class." + type: "object" + properties: + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + priority: + description: "A way that can be used by consumers to prioritize orders in\ + \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ + \ and 4 the lowest)" + type: "string" + description: + description: "A free-text description of the service order" + type: "string" + category: + description: "Used to categorize the order that can be useful for the OM system\ + \ (e.g. “broadband”, “TVOption”, ...)" + type: "string" + requestedStartDate: + description: "Order start date wished by the requestor" + type: "string" + format: "date-time" + requestedCompletionDate: + description: "Requested delivery date from the requestor perspective" + type: "string" + format: "date-time" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedParty" + orderRelationship: + type: "array" + items: + $ref: "#/definitions/OrderRelationship" + orderItem: + type: "array" + items: + $ref: "#/definitions/CreateServiceOrderItem" + ServiceOrderSummary: + description: "This structure is used to provide a subset of serviceOrder attributes\ + \ to be provided in particular for notification messages" + required: + - "id" + type: "object" + properties: + id: + description: "ID created on repository side" + type: "string" + href: + description: "Hyperlink to access the order" + type: "string" + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + state: + $ref: "#/definitions/StateType" + orderDate: + description: "" + type: "string" + format: "date-time" + completionDateTime: + description: "Date when the order was completed" + type: "string" + format: "date-time" + Notification: + description: "Notification structure for a serviceOrdering notification" + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + $ref: "#/definitions/EventType" + event: + $ref: "#/definitions/ServiceOrderSummaryWithItem" + ServiceOrderItemSummary: + description: "Service Order item summary to be used for notification" + required: + - "id" + - "service" + type: "object" + properties: + id: + description: "Identifier of the line item (generally it is a sequence number\ + \ 01, 02, 03, …)" + type: "string" + action: + $ref: "#/definitions/ActionType" + state: + $ref: "#/definitions/StateType" + service: + $ref: "#/definitions/Service" + ServiceOrderSummaryWithItem: + description: "Service order item summary with item description" + required: + - "id" + type: "object" + properties: + id: + description: "ID created on repository side" + type: "string" + href: + description: "Hyperlink to access the order" + type: "string" + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + state: + $ref: "#/definitions/StateType" + orderDate: + description: "" + type: "string" + format: "date-time" + completionDateTime: + description: "Date when the order was completed" + type: "string" + format: "date-time" + orderItem: + type: "array" + items: + $ref: "#/definitions/ServiceOrderItemSummary" + OrderMessage: + description: "An optional array of messages associated with the Order" + required: + - "severity" + - "correctionRequired" + type: "object" + properties: + code: + description: "A code associated to this message" + type: "string" + field: + description: "Service Order attribute related to this error message" + type: "string" + messageInformation: + description: "Message related to this order" + type: "string" + severity: + $ref: "#/definitions/SeverityMessage" + correctionRequired: + description: "Indicator that an action is required to allow service order\ + \ fullfilment to follow up" + type: "boolean" diff --git a/docs/offeredapis/api_status/api.plantuml b/docs/offeredapis/api_status/api.plantuml new file mode 100644 index 0000000..6c5ed42 --- /dev/null +++ b/docs/offeredapis/api_status/api.plantuml @@ -0,0 +1,43 @@ +@startuml + +enum StatusValue { + ok + ko +} +enum ComponentsName { + sdc connectivity + so connectivity + aai connectivity + dmaap connectivity +} +enum ApplicationName { + nbi +} + +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 Component + Component --> "1-1" ComponentsName : name + Component --> "1-1" StatusValue : status + +class Status { + version:string +} + Status --> "1-1" ApplicationName : name + Status --> "1-1" StatusValue : status + Status --> "0-*" Component : components + +@enduml \ No newline at end of file diff --git a/docs/offeredapis/api_status/model.xsd b/docs/offeredapis/api_status/model.xsd new file mode 100644 index 0000000..9b1d7ee --- /dev/null +++ b/docs/offeredapis/api_status/model.xsd @@ -0,0 +1,114 @@ + + + + API Designer + Model: status + Version: 4.0.0_inProgress + Owner: ONAPNBI + Generated on: 2019-03-12T16:45:47.241Z + Generated by: Orange API Designer v2, model-v1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + application name + + + + + + + + + + + + + + + + + + + + diff --git a/docs/offeredapis/api_status/swagger.json b/docs/offeredapis/api_status/swagger.json new file mode 100644 index 0000000..9bb198f --- /dev/null +++ b/docs/offeredapis/api_status/swagger.json @@ -0,0 +1,230 @@ + + { + "swagger": "2.0", + "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.0_inProgress", + "title": "API Status", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "localhost:8080", + "basePath": "/nbi/api/v4", + "schemes": [ + "http" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "Status", + "description": "" + } + ], + "paths": { + "/status": { + "get": { + "tags": [ + "Status" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "statusFind", + "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, + + "parameters": [ + + { + "name": "fullStatus", + "required": false, + "in": "query", + "description": "", + + "type": "boolean", + + "default": false + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Status" + } + + } + } + } + } + }, + "definitions": { + + "StatusValue": { + "description": "", + + "type": "string", + "enum": [ + "ok", + "ko"] + + }, + "ComponentsName": { + "description": "", + + "type": "string", + "enum": [ + "sdc connectivity", + "so connectivity", + "aai connectivity", + "dmaap connectivity"] + + }, + "ApplicationName": { + "description": "", + + "type": "string", + "enum": [ + "nbi"] + + }, + + "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" + } + } + } + + }, + + "Component": { + "description": "", + + + "required": [ + + "name", + "status" + ], + "type": "object", + "properties": { + "name": { + + "$ref": "#/definitions/ComponentsName" + }, + "status": { + + "$ref": "#/definitions/StatusValue" + } + } + + }, + + "Status": { + "description": "", + + + "required": [ + + "name", + "status", + "version", + "components" + ], + "type": "object", + "properties": { + "name": { + + "$ref": "#/definitions/ApplicationName" + }, + "status": { + + "$ref": "#/definitions/StatusValue" + }, + "version": { + "description": "", + "type": "string" + }, + "components": { + + "type": "array", + "items": { + "$ref": "#/definitions/Component" + } + } + } + + } + } + } + \ No newline at end of file diff --git a/docs/offeredapis/api_status/swagger.yaml b/docs/offeredapis/api_status/swagger.yaml new file mode 100644 index 0000000..88177de --- /dev/null +++ b/docs/offeredapis/api_status/swagger.yaml @@ -0,0 +1,145 @@ +swagger: "2.0" +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.0_inProgress" + title: "API Status" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "localhost:8080" +basePath: "/nbi/api/v4" +schemes: +- "http" +produces: +- "application/json;charset=utf-8" +tags: +- name: "Status" + description: "" +paths: + /status: + get: + tags: + - "Status" + produces: + - "application/json;charset=utf-8" + operationId: "statusFind" + 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 + parameters: + - name: "fullStatus" + required: false + in: "query" + description: "" + type: "boolean" + default: false + responses: + 200: + description: "Ok" + schema: + $ref: "#/definitions/Status" +definitions: + StatusValue: + description: "" + type: "string" + enum: + - "ok" + - "ko" + ComponentsName: + description: "" + type: "string" + enum: + - "sdc connectivity" + - "so connectivity" + - "aai connectivity" + - "dmaap connectivity" + ApplicationName: + description: "" + type: "string" + enum: + - "nbi" + 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" + Component: + description: "" + required: + - "name" + - "status" + type: "object" + properties: + name: + $ref: "#/definitions/ComponentsName" + status: + $ref: "#/definitions/StatusValue" + Status: + description: "" + required: + - "name" + - "status" + - "version" + - "components" + type: "object" + properties: + name: + $ref: "#/definitions/ApplicationName" + status: + $ref: "#/definitions/StatusValue" + version: + description: "" + type: "string" + components: + type: "array" + items: + $ref: "#/definitions/Component" diff --git a/docs/offeredapis/images/text_xml.png b/docs/offeredapis/images/text_xml.png new file mode 100644 index 0000000..f8c4b96 Binary files /dev/null and b/docs/offeredapis/images/text_xml.png differ diff --git a/docs/offeredapis/listener/apiListener.plantuml b/docs/offeredapis/listener/apiListener.plantuml deleted file mode 100644 index fe5ebc8..0000000 --- a/docs/offeredapis/listener/apiListener.plantuml +++ /dev/null @@ -1,26 +0,0 @@ -@startuml - -enum EventType { - ServiceOrderCreationNotification - ServiceOrderStateChangeNotification - ServiceOrderItemStateChangeNotification -} - -class ErrorRepresentation { - code:int - reason:string - message:string - status:int - referenceError:string - @type:string - @schemaLocation:string -} - -class Listener { - eventId:string - eventDate:dateTime - event:object -} - Listener --> "1-1" EventType : eventType - -@enduml \ No newline at end of file diff --git a/docs/offeredapis/listener/asciiDoc.adoc b/docs/offeredapis/listener/asciiDoc.adoc deleted file mode 100644 index dcbb054..0000000 --- a/docs/offeredapis/listener/asciiDoc.adoc +++ /dev/null @@ -1,175 +0,0 @@ -= API Listener - - -[[_overview]] -== Overview - -=== Api URL - -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/swagger.json[Swagger UI] - - -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/plantuml&noCache=7322.0[plant UML UI] - -Listener API has to be implemented on the client side in order to receive notification. -Notification are received if HUB has been posted on server side. - - -=== Version information -[%hardbreaks] -__Version__ : 0.1.0_inProgress - - -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /externalapi/listener/v1 -__Schemes__ : HTTPS - - -=== Tags - -* Listener - - -=== Produces - -* `application/json;charset=utf-8` - - -[[_paths]] -== Resources - -[[_listener_resource]] -=== Listener - -[[_listenercreate]] -==== createEvent -.... -POST /listener -.... - - -===== Description -The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Body**|**event** + -__required__|<<_listener,Listener>> -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**201**|Success|<<_listener,Listener>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Consumes - -* `application/json;charset=utf-8` - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_definitions]] -== Definitions - -[[_errorrepresentation]] -=== ErrorRepresentation - -[options="header", cols=".^3,.^4"] -|=== -|Name|Schema -|**@schemaLocation** + -__optional__|string -|**@type** + -__optional__|string -|**code** + -__required__|integer (int32) -|**message** + -__optional__|string -|**reason** + -__optional__|string -|**referenceError** + -__optional__|string -|**status** + -__optional__|integer (int32) -|=== - - -[[_eventtype]] -=== EventType -__Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) - - -[[_listener]] -=== Listener -An event will be triggered for each time a notification is send to a listener. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**event** + -__required__|An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.|object -|**eventDate** + -__required__||string (date-time) -|**eventId** + -__required__|id of the event|string -|**eventType** + -__required__||<<_eventtype,EventType>> -|=== - diff --git a/docs/offeredapis/listener/documentation.html b/docs/offeredapis/listener/documentation.html deleted file mode 100644 index 58cb7e2..0000000 --- a/docs/offeredapis/listener/documentation.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - - - -API Listener - - - - - -
-
-

Overview

-
-
-

Api URL

-
-

Swagger UI

-
-
-

plant UML UI

-
-
-

Listener API has to be implemented on the client side in order to receive notification. -Notification are received if HUB has been posted on server side.

-
-
-
-

Version information

-
-

Version : 0.1.0_inProgress

-
-
-
-

URI scheme

-
-

Host : serverRoot
-BasePath : /externalapi/listener/v1
-Schemes : HTTPS

-
-
-
-

Tags

-
-
    -
  • -

    Listener

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-

Resources

-
-
-

Listener

-
-

createEvent

-
-
-
POST /listener
-
-
-
-
Description
-
-

The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Body

event
-required

Listener

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

201

Success

Listener

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Consumes
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-
-
-

Definitions

-
-
-

ErrorRepresentation

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameSchema

@schemaLocation
-optional

string

@type
-optional

string

code
-required

integer (int32)

message
-optional

string

reason
-optional

string

referenceError
-optional

string

status
-optional

integer (int32)

-
-
-

EventType

-
-

Type : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

-
-
-
-

Listener

-
-

An event will be triggered for each time a notification is send to a listener.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

event
-required

An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.

object

eventDate
-required

string (date-time)

eventId
-required

id of the event

string

eventType
-required

EventType

-
-
-
-
- - - \ No newline at end of file diff --git a/docs/offeredapis/listener/markDown.md b/docs/offeredapis/listener/markDown.md deleted file mode 100644 index 332c6cf..0000000 --- a/docs/offeredapis/listener/markDown.md +++ /dev/null @@ -1,122 +0,0 @@ -# API Listener - - - -## Overview - -### Api URL - -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/swagger.json) - - -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/plantuml&noCache=7322.0) - -Listener API has to be implemented on the client side in order to receive notification. -Notification are received if HUB has been posted on server side. - - -### Version information -*Version* : 0.1.0_inProgress - - -### URI scheme -*Host* : serverRoot -*BasePath* : /externalapi/listener/v1 -*Schemes* : HTTPS - - -### Tags - -* Listener - - -### Produces - -* `application/json;charset=utf-8` - - - -## Resources - - -### Listener - - -#### createEvent -``` -POST /listener -``` - - -##### Description -The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Body**|**event**
*required*|[Listener](#listener)| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**201**|Success|[Listener](#listener)| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Consumes - -* `application/json;charset=utf-8` - - -##### Produces - -* `application/json;charset=utf-8` - - - -## Definitions - - -### ErrorRepresentation - -|Name|Schema| -|---|---| -|**@schemaLocation**
*optional*|string| -|**@type**
*optional*|string| -|**code**
*required*|integer (int32)| -|**message**
*optional*|string| -|**reason**
*optional*|string| -|**referenceError**
*optional*|string| -|**status**
*optional*|integer (int32)| - - - -### EventType -*Type* : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) - - - -### Listener -An event will be triggered for each time a notification is send to a listener. - - -|Name|Description|Schema| -|---|---|---| -|**event**
*required*|An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.|object| -|**eventDate**
*required*||string (date-time)| -|**eventId**
*required*|id of the event|string| -|**eventType**
*required*||[EventType](#eventtype)| - diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index ef51d1c..9845165 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -79,16 +79,19 @@ API Table .. |postman-icon| image:: images/postman.png :width: 40px +.. |xml-icon| image:: images/text_xml.png + :width: 40px + .. csv-table:: - :header: "API", "|swagger-icon|", "|html-icon|", "|plantuml-icon|", "|swagger-icon|", "|postman-icon|", "|pdf-icon|" - :widths: 10,5,5,5,5,5,5 - - " ", "json file", "html doc", "plantUML doc", "Swagger Editor", "Postman Collection", "pdf doc" - "serviceCatalog", ":download:`link `", ":download:`link `", ":download:`link `", "coming", "coming", "coming" - "serviceInventory", ":download:`link `", ":download:`link `", ":download:`link `", "coming", "coming", "coming" - "serviceOrder", ":download:`link `", ":download:`link `", ":download:`link `", "coming", ":download:`link `", "coming" - "listener", ":download:`link `", ":download:`link `", ":download:`link `", "coming", "coming", "coming" - "healthCheck", ":download:`link `", "coming", "coming", "coming", "coming", "coming" + :header: "API", "|swagger-icon|", "|swagger-icon|", "|plantuml-icon|", "|xml-icon|" + :widths: 10,5,5,5,5 + + " ", "json file", "yaml file", "plant UML file", "xml schemas" + "hub", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" + "serviceCatalog", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" + "serviceInventory", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" + "serviceOrder", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" + "status", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" *************** API Description diff --git a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml deleted file mode 100644 index 8483238..0000000 --- a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml +++ /dev/null @@ -1,110 +0,0 @@ -@startuml - -enum LifecycleStatusValues { - NOT_CERTIFIED_CHECKOUT - NOT_CERTIFIED_CHECKIN - READY_FOR_CERTIFICATION - CERTIFICATION_IN_PROGRESS - CERTIFIED -} -enum DistributionStatus { - DISTRIBUTION_NOT_APPROVED - DISTRIBUTION_APPROVED - DISTRIBUTED - DISTRIBUTION_REJECTED -} - -class ErrorRepresentation { - code:int - reason:string - message:string - status:string - referenceErrror:string - @type:string - @schemaLocation:string -} - -class TimePeriod { - startDateTime:dateTime - endDateTime:dateTime -} - -class RelatedPartyRef { - id:string - role:string - name:string -} - -class ServiceSpecification { - id:string - href:string - name:string - description:string - @type:string - @schemaLocation:string - @baseType:string - invariantUUID:string - toscaModelURL:string - toscaResourceName:string - category:string - subcategory:string - version:string -} - ServiceSpecification --> "0-1" DistributionStatus : distributionStatus - ServiceSpecification --> "0-1" LifecycleStatusValues : lifecycleStatus - ServiceSpecification --> "0-1" TargetServiceSchemaRef : targetServiceSchema - ServiceSpecification --> "0-*" Attachment : attachment - ServiceSpecification --> "0-*" RelatedPartyRef : relatedParty - ServiceSpecification --> "0-*" ResourceSpecificationRef : resourceSpecification - ServiceSpecification --> "0-*" ServiceSpecCharacteristic : serviceSpecCharacteristic - -class ServiceSpecCharacteristic { - name:string - description:string - valueType:string - @type:string - @schemaLocation:string - required:boolean - status:string -} - ServiceSpecCharacteristic --> "0-*" ServiceSpecCharacteristicValue : serviceSpecCharacteristicValue - -class Attachment { - id:string - name:string - description:string - @type:string - artifactLabel:string - artifactGroupType:string - artifactTimeout:string - artifactChecksum:string - artifactVersion:string - generatedFromUUID:string - url:string - mimeType:string -} - -class ServiceSpecCharacteristicValue { - valueType:string - isDefault:boolean - value:string -} - -class ResourceSpecificationRef { - id:string - version:string - name:string - @type:string - resourceInstanceName:string - resourceInvariantUUID:string - resourceType:string - modelCustomizationName:string - modelCustomizationId:string -} - -class TargetServiceSchemaRef { - @type:string - @schemaLocation:string -} - -@enduml \ No newline at end of file diff --git a/docs/offeredapis/serviceCatalog/asciiDoc.adoc b/docs/offeredapis/serviceCatalog/asciiDoc.adoc deleted file mode 100644 index 9ce1396..0000000 --- a/docs/offeredapis/serviceCatalog/asciiDoc.adoc +++ /dev/null @@ -1,492 +0,0 @@ -= API ServiceCatalog - - -[[_overview]] -== Overview - -=== Api URL - -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json[Swagger UI] - - -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0[plant UML UI] - -serviceCatalog API designed for ONAP Beijing Release. -This API is build from TMF open API17.5. -Only operation GET (by id & byList) for resource serviceSpecification is available - - -=== Version information -[%hardbreaks] -__Version__ : 3.0.0_inProgress - - -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /nbi/api/v3 -__Schemes__ : HTTPS - - -=== Tags - -* ServiceSpecification - - -=== Produces - -* `application/json;charset=utf-8` - - -[[_paths]] -== Resources - -[[_servicespecification_resource]] -=== ServiceSpecification - -[[_servicespecificationfind]] -==== List service specifications -.... -GET /serviceSpecification -.... - - -===== Description -This operation returns service specifications from a catalog. -Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering -Fields attribute could be used to filter attributes retrieved - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4"] -|=== -|Type|Name|Description|Schema -|**Query**|**category** + -__optional__|Service Category (filter)|string -|**Query**|**distributionStatus** + -__optional__|Service distribution status (filter)|string -|**Query**|**fields** + -__optional__|Field selection - used to filtering the attributes to be retreived|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|< <<_servicespecification,ServiceSpecification>> > array -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_servicespecificationget]] -==== Retrieve a service specification -.... -GET /serviceSpecification/{id} -.... - - -===== Description -This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4"] -|=== -|Type|Name|Description|Schema -|**Path**|**id** + -__required__||string -|**Query**|**fields** + -__optional__|Attribute selection|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|<<_servicespecification,ServiceSpecification>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_definitions]] -== Definitions - -[[_attachment]] -=== Attachment -An attachment is a file uses to describe the service. -In nbi we use attachment to retrieve ONAP artifacts. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: -artifactLabel -artifactGroupType -artifactTimeout -artifactChecksum -artifactVersion -generatedFromUUID + -**Default** : `"ONAPartifact"`|string -|**artifactChecksum** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactChecksum|string -|**artifactGroupType** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactGroupType|string -|**artifactLabel** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactLabel|string -|**artifactTimeout** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactTimeout|string -|**artifactVersion** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactVersion|string -|**description** + -__optional__|Description of the attachment - filled with artifactDescription|string -|**generatedFromUUID** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID|string -|**id** + -__optional__|Unique identifier of the attachment - filled with artifactUUID.|string -|**mimeType** + -__optional__|Filled with artifactType|string -|**name** + -__optional__|Name of the attachment - filled with artifactName|string -|**url** + -__optional__|Uniform Resource Locator, is a web page address - filled with artifactURL|string -|=== - - -[[_distributionstatus]] -=== DistributionStatus -Service distribution status from ONAP. - -__Type__ : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED) - - -[[_errorrepresentation]] -=== ErrorRepresentation -This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|it provides a link to the schema describing a REST resource.|string -|**@type** + -__optional__|The class type of a REST resource.|string -|**code** + -__required__|Application related code (as defined in the API or from a common list)|integer (int32) -|**message** + -__optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string -|**reason** + -__required__|Text that explains the reason for error. This can be shown to a client user.|string -|**referenceErrror** + -__optional__|url pointing to documentation describing the error|string -|**status** + -__optional__|http error code extension like 400-2|string -|=== - - -[[_lifecyclestatusvalues]] -=== LifecycleStatusValues -Service lifecycle value from ONAP SDC - -__Type__ : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED) - - -[[_relatedpartyref]] -=== RelatedPartyRef -Party linked to the service catalog. -in nbi we retrieve information about last updater of the service in SDC - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**id** + -__optional__|Unique identifier of the related party. Filled with lastUpdaterUserId|string -|**name** + -__optional__|Name of the related party - Filled with lastUpdatedFullName|string -|**role** + -__optional__|Role payed by the related party -Only role 'lastUpdater' is retrieved in Beijing release|string -|=== - - -[[_resourcespecificationref]] -=== ResourceSpecificationRef -A list of resourceSpec identified to deliver the service. -for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes: -resourceInstanceName -resourceInvariantUUID -resourceType -modelCustomizationName -modelCustomizationId + -**Default** : `"ONAPresource"`|string -|**id** + -__optional__|Unique identifier of the resource specification - filled with resourceUUID|string -|**modelCustomizationId** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource|string -|**modelCustomizationName** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource|string -|**name** + -__optional__|Name of the resource specification - filled with resourceName|string -|**resourceInstanceName** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName|string -|**resourceInvariantUUID** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID|string -|**resourceType** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - resoucreType|string -|**version** + -__optional__|Version for this resource specification - filled with resourceVersion|string -|=== - - -[[_servicespeccharacteristic]] -=== ServiceSpecCharacteristic -A characteristic quality or distinctive feature of a ServiceSpecification. -ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|An url pointing to type description - we do not use it in nbi Beijing release|string -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.|string -|**description** + -__optional__|A narrative that explains in detail what the characteristic is - Filled with parameter_description|string -|**name** + -__optional__|Name of the characteristic - Filled with parameter_name|string -|**required** + -__optional__|A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’ + -**Default** : `true`|boolean -|**serviceSpecCharacteristicValue** + -__optional__||< <<_servicespeccharacteristicvalue,ServiceSpecCharacteristicValue>> > array -|**status** + -__optional__|Status of the characteristic - filled with status_value|string -|**valueType** + -__optional__|A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type|string -|=== - - -[[_servicespeccharacteristicvalue]] -=== ServiceSpecCharacteristicValue -A number or text that can be assigned to a service specification characteristic. -ServiceSpecCharacteristicValue are retrieved in the service Tosca file - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**isDefault** + -__optional__|Information calculated from parameter default in the Tosca file|boolean -|**value** + -__optional__|A discrete value that the characteristic can take on|string -|**valueType** + -__optional__|A kind of value that the characteristic can take on, such as numeric, text, and so forth -Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. -We do not manage parameter_type= list or map for Beijing release|string -|=== - - -[[_servicespecification]] -=== ServiceSpecification -ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. -the service information are retrieved in SDC - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__|Not used for Beijing release|string -|**@schemaLocation** + -__optional__|Not used for Beijing release|string -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes: -invariantUUID -toscaModelURL -toscaResourceName -category (1) -subcategory (1) -distributionStatus + -**Default** : `"ONAPservice"`|string -|**attachment** + -__optional__||< <<_attachment,Attachment>> > array -|**category** + -__optional__|Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we'll introduce category resource|string -|**description** + -__optional__|A narrative that explains in detail what the service specification is - Filled with SDC Service description|string -|**distributionStatus** + -__optional__||<<_distributionstatus,DistributionStatus>> -|**href** + -__optional__|Reference of the service specification- not mapped in Beijing|string -|**id** + -__optional__|Unique identifier of the service specification. Filled with SDC Service uuid|string -|**invariantUUID** + -__required__|Additional attribute (not in the TMF API) - extended through @type - invariantUUID|string -|**lifecycleStatus** + -__optional__||<<_lifecyclestatusvalues,LifecycleStatusValues>> -|**name** + -__optional__|Name of the service specification- Filled with SDC Service name|string -|**relatedParty** + -__optional__||< <<_relatedpartyref,RelatedPartyRef>> > array -|**resourceSpecification** + -__optional__||< <<_resourcespecificationref,ResourceSpecificationRef>> > array -|**serviceSpecCharacteristic** + -__optional__||< <<_servicespeccharacteristic,ServiceSpecCharacteristic>> > array -|**subcategory** + -__optional__|Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we'll introduce category resourc|string -|**targetServiceSchema** + -__optional__||<<_targetserviceschemaref,TargetServiceSchemaRef>> -|**toscaModelURL** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - toscaModelURL|string -|**toscaResourceName** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - toscaResourceName|string -|**version** + -__optional__|Service specification version - Filled with SDC Service version|string -|=== - - -[[_targetserviceschemaref]] -=== TargetServiceSchemaRef - -[options="header", cols=".^3,.^4"] -|=== -|Name|Schema -|**@schemaLocation** + -__required__|string -|**@type** + -__required__|string -|=== - - -[[_timeperiod]] -=== TimePeriod -A time period - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**endDateTime** + -__optional__|End date and time of the period|string (date-time) -|**startDateTime** + -__optional__|Start date and time of the period|string (date-time) -|=== - diff --git a/docs/offeredapis/serviceCatalog/documentation.html b/docs/offeredapis/serviceCatalog/documentation.html deleted file mode 100644 index 94b011f..0000000 --- a/docs/offeredapis/serviceCatalog/documentation.html +++ /dev/null @@ -1,1489 +0,0 @@ - - - - - - - -API ServiceCatalog - - - - - -
-
-

Overview

-
-
-

Api URL

-
-

Swagger UI

-
-
-

plant UML UI

-
-
-

serviceCatalog API designed for ONAP Beijing Release. -This API is build from TMF open API17.5. -Only operation GET (by id & byList) for resource serviceSpecification is available

-
-
-
-

Version information

-
-

Version : 3.0.0_inProgress

-
-
-
-

URI scheme

-
-

Host : serverRoot
-BasePath : /nbi/api/v3
-Schemes : HTTPS

-
-
-
-

Tags

-
-
    -
  • -

    ServiceSpecification

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-

Resources

-
-
-

ServiceSpecification

-
-

List service specifications

-
-
-
GET /serviceSpecification
-
-
-
-
Description
-
-

This operation returns service specifications from a catalog. -Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering -Fields attribute could be used to filter attributes retrieved

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionSchema

Query

category
-optional

Service Category (filter)

string

Query

distributionStatus
-optional

Service distribution status (filter)

string

Query

fields
-optional

Field selection - used to filtering the attributes to be retreived

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

< ServiceSpecification > array

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Retrieve a service specification

-
-
-
GET /serviceSpecification/{id}
-
-
-
-
Description
-
-

This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ------ - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionSchema

Path

id
-required

string

Query

fields
-optional

Attribute selection

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

ServiceSpecification

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-
-
-

Definitions

-
-
-

Attachment

-
-

An attachment is a file uses to describe the service. -In nbi we use attachment to retrieve ONAP artifacts.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@type
-optional

This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: -artifactLabel -artifactGroupType -artifactTimeout -artifactChecksum -artifactVersion -generatedFromUUID
-Default : "ONAPartifact"

string

artifactChecksum
-optional

Additional attribute (not in the TMF API) - extended through @type - artifactChecksum

string

artifactGroupType
-optional

Additional attribute (not in the TMF API) - extended through @type - artifactGroupType

string

artifactLabel
-optional

Additional attribute (not in the TMF API) - extended through @type - artifactLabel

string

artifactTimeout
-optional

Additional attribute (not in the TMF API) - extended through @type - artifactTimeout

string

artifactVersion
-optional

Additional attribute (not in the TMF API) - extended through @type - artifactVersion

string

description
-optional

Description of the attachment - filled with artifactDescription

string

generatedFromUUID
-optional

Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID

string

id
-optional

Unique identifier of the attachment - filled with artifactUUID.

string

mimeType
-optional

Filled with artifactType

string

name
-optional

Name of the attachment - filled with artifactName

string

url
-optional

Uniform Resource Locator, is a web page address - filled with artifactURL

string

-
-
-

DistributionStatus

-
-

Service distribution status from ONAP.

-
-
-

Type : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED)

-
-
-
-

ErrorRepresentation

-
-

This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

it provides a link to the schema describing a REST resource.

string

@type
-optional

The class type of a REST resource.

string

code
-required

Application related code (as defined in the API or from a common list)

integer (int32)

message
-optional

Text that provide more details and corrective actions related to the error. This can be shown to a client user

string

reason
-required

Text that explains the reason for error. This can be shown to a client user.

string

referenceErrror
-optional

url pointing to documentation describing the error

string

status
-optional

http error code extension like 400-2

string

-
-
-

LifecycleStatusValues

-
-

Service lifecycle value from ONAP SDC

-
-
-

Type : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED)

-
-
-
-

RelatedPartyRef

-
-

Party linked to the service catalog. -in nbi we retrieve information about last updater of the service in SDC

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of the related party. Filled with lastUpdaterUserId

string

name
-optional

Name of the related party - Filled with lastUpdatedFullName

string

role
-optional

Role payed by the related party -Only role 'lastUpdater' is retrieved in Beijing release

string

-
-
-

ResourceSpecificationRef

-
-

A list of resourceSpec identified to deliver the service. -for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@type
-optional

This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes: -resourceInstanceName -resourceInvariantUUID -resourceType -modelCustomizationName -modelCustomizationId
-Default : "ONAPresource"

string

id
-optional

Unique identifier of the resource specification - filled with resourceUUID

string

modelCustomizationId
-optional

Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource

string

modelCustomizationName
-optional

Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource

string

name
-optional

Name of the resource specification - filled with resourceName

string

resourceInstanceName
-optional

Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName

string

resourceInvariantUUID
-optional

Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID

string

resourceType
-optional

Additional attribute (not in the TMF API) - extended through @type - resoucreType

string

version
-optional

Version for this resource specification - filled with resourceVersion

string

-
-
-

ServiceSpecCharacteristic

-
-

A characteristic quality or distinctive feature of a ServiceSpecification. -ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

An url pointing to type description - we do not use it in nbi Beijing release

string

@type
-optional

This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.

string

description
-optional

A narrative that explains in detail what the characteristic is - Filled with parameter_description

string

name
-optional

Name of the characteristic - Filled with parameter_name

string

required
-optional

A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’
-Default : true

boolean

serviceSpecCharacteristicValue
-optional

< ServiceSpecCharacteristicValue > array

status
-optional

Status of the characteristic - filled with status_value

string

valueType
-optional

A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type

string

-
-
-

ServiceSpecCharacteristicValue

-
-

A number or text that can be assigned to a service specification characteristic. -ServiceSpecCharacteristicValue are retrieved in the service Tosca file

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

isDefault
-optional

Information calculated from parameter default in the Tosca file

boolean

value
-optional

A discrete value that the characteristic can take on

string

valueType
-optional

A kind of value that the characteristic can take on, such as numeric, text, and so forth -Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. -We do not manage parameter_type= list or map for Beijing release

string

-
-
-

ServiceSpecification

-
-

ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. -the service information are retrieved in SDC

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

Not used for Beijing release

string

@schemaLocation
-optional

Not used for Beijing release

string

@type
-optional

This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes: -invariantUUID -toscaModelURL -toscaResourceName -category (1) -subcategory (1) -distributionStatus
-Default : "ONAPservice"

string

attachment
-optional

< Attachment > array

category
-optional

Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we’ll introduce category resource

string

description
-optional

A narrative that explains in detail what the service specification is - Filled with SDC Service description

string

distributionStatus
-optional

DistributionStatus

href
-optional

Reference of the service specification- not mapped in Beijing

string

id
-optional

Unique identifier of the service specification. Filled with SDC Service uuid

string

invariantUUID
-required

Additional attribute (not in the TMF API) - extended through @type - invariantUUID

string

lifecycleStatus
-optional

LifecycleStatusValues

name
-optional

Name of the service specification- Filled with SDC Service name

string

relatedParty
-optional

< RelatedPartyRef > array

resourceSpecification
-optional

< ResourceSpecificationRef > array

serviceSpecCharacteristic
-optional

< ServiceSpecCharacteristic > array

subcategory
-optional

Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we’ll introduce category resourc

string

targetServiceSchema
-optional

TargetServiceSchemaRef

toscaModelURL
-optional

Additional attribute (not in the TMF API) - extended through @type - toscaModelURL

string

toscaResourceName
-optional

Additional attribute (not in the TMF API) - extended through @type - toscaResourceName

string

version
-optional

Service specification version - Filled with SDC Service version

string

-
-
-

TargetServiceSchemaRef

- ---- - - - - - - - - - - - - - - - - -
NameSchema

@schemaLocation
-required

string

@type
-required

string

-
-
-

TimePeriod

-
-

A time period

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

endDateTime
-optional

End date and time of the period

string (date-time)

startDateTime
-optional

Start date and time of the period

string (date-time)

-
-
-
-
- - - \ No newline at end of file diff --git a/docs/offeredapis/serviceCatalog/markDown.md b/docs/offeredapis/serviceCatalog/markDown.md deleted file mode 100644 index 7f1a02d..0000000 --- a/docs/offeredapis/serviceCatalog/markDown.md +++ /dev/null @@ -1,299 +0,0 @@ -# API ServiceCatalog - - - -## Overview - -### Api URL - -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json) - - -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0) - -serviceCatalog API designed for ONAP Beijing Release. -This API is build from TMF open API17.5. -Only operation GET (by id & byList) for resource serviceSpecification is available - - -### Version information -*Version* : 3.0.0_inProgress - - -### URI scheme -*Host* : serverRoot -*BasePath* : /nbi/api/v3 -*Schemes* : HTTPS - - -### Tags - -* ServiceSpecification - - -### Produces - -* `application/json;charset=utf-8` - - - -## Resources - - -### ServiceSpecification - - -#### List service specifications -``` -GET /serviceSpecification -``` - - -##### Description -This operation returns service specifications from a catalog. -Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering -Fields attribute could be used to filter attributes retrieved - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Description|Schema| -|---|---|---|---| -|**Query**|**category**
*optional*|Service Category (filter)|string| -|**Query**|**distributionStatus**
*optional*|Service distribution status (filter)|string| -|**Query**|**fields**
*optional*|Field selection - used to filtering the attributes to be retreived|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|< [ServiceSpecification](#servicespecification) > array| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -#### Retrieve a service specification -``` -GET /serviceSpecification/{id} -``` - - -##### Description -This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Description|Schema| -|---|---|---|---| -|**Path**|**id**
*required*||string| -|**Query**|**fields**
*optional*|Attribute selection|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|[ServiceSpecification](#servicespecification)| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -## Definitions - - -### Attachment -An attachment is a file uses to describe the service. -In nbi we use attachment to retrieve ONAP artifacts. - - -|Name|Description|Schema| -|---|---|---| -|**@type**
*optional*|This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes:
artifactLabel
artifactGroupType
artifactTimeout
artifactChecksum
artifactVersion
generatedFromUUID
**Default** : `"ONAPartifact"`|string| -|**artifactChecksum**
*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactChecksum|string| -|**artifactGroupType**
*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactGroupType|string| -|**artifactLabel**
*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactLabel|string| -|**artifactTimeout**
*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactTimeout|string| -|**artifactVersion**
*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactVersion|string| -|**description**
*optional*|Description of the attachment - filled with artifactDescription|string| -|**generatedFromUUID**
*optional*|Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID|string| -|**id**
*optional*|Unique identifier of the attachment - filled with artifactUUID.|string| -|**mimeType**
*optional*|Filled with artifactType|string| -|**name**
*optional*|Name of the attachment - filled with artifactName|string| -|**url**
*optional*|Uniform Resource Locator, is a web page address - filled with artifactURL|string| - - - -### DistributionStatus -Service distribution status from ONAP. - -*Type* : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED) - - - -### ErrorRepresentation -This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|it provides a link to the schema describing a REST resource.|string| -|**@type**
*optional*|The class type of a REST resource.|string| -|**code**
*required*|Application related code (as defined in the API or from a common list)|integer (int32)| -|**message**
*optional*|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string| -|**reason**
*required*|Text that explains the reason for error. This can be shown to a client user.|string| -|**referenceErrror**
*optional*|url pointing to documentation describing the error|string| -|**status**
*optional*|http error code extension like 400-2|string| - - - -### LifecycleStatusValues -Service lifecycle value from ONAP SDC - -*Type* : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED) - - - -### RelatedPartyRef -Party linked to the service catalog. -in nbi we retrieve information about last updater of the service in SDC - - -|Name|Description|Schema| -|---|---|---| -|**id**
*optional*|Unique identifier of the related party. Filled with lastUpdaterUserId|string| -|**name**
*optional*|Name of the related party - Filled with lastUpdatedFullName|string| -|**role**
*optional*|Role payed by the related party
Only role 'lastUpdater' is retrieved in Beijing release|string| - - - -### ResourceSpecificationRef -A list of resourceSpec identified to deliver the service. -for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. - - -|Name|Description|Schema| -|---|---|---| -|**@type**
*optional*|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:
resourceInstanceName
resourceInvariantUUID
resourceType
modelCustomizationName
modelCustomizationId
**Default** : `"ONAPresource"`|string| -|**id**
*optional*|Unique identifier of the resource specification - filled with resourceUUID|string| -|**modelCustomizationId**
*optional*|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource|string| -|**modelCustomizationName**
*optional*|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource|string| -|**name**
*optional*|Name of the resource specification - filled with resourceName|string| -|**resourceInstanceName**
*optional*|Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName|string| -|**resourceInvariantUUID**
*optional*|Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID|string| -|**resourceType**
*optional*|Additional attribute (not in the TMF API) - extended through @type - resoucreType|string| -|**version**
*optional*|Version for this resource specification - filled with resourceVersion|string| - - - -### ServiceSpecCharacteristic -A characteristic quality or distinctive feature of a ServiceSpecification. -ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|An url pointing to type description - we do not use it in nbi Beijing release|string| -|**@type**
*optional*|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.|string| -|**description**
*optional*|A narrative that explains in detail what the characteristic is - Filled with parameter_description|string| -|**name**
*optional*|Name of the characteristic - Filled with parameter_name|string| -|**required**
*optional*|A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’
**Default** : `true`|boolean| -|**serviceSpecCharacteristicValue**
*optional*||< [ServiceSpecCharacteristicValue](#servicespeccharacteristicvalue) > array| -|**status**
*optional*|Status of the characteristic - filled with status_value|string| -|**valueType**
*optional*|A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type|string| - - - -### ServiceSpecCharacteristicValue -A number or text that can be assigned to a service specification characteristic. -ServiceSpecCharacteristicValue are retrieved in the service Tosca file - - -|Name|Description|Schema| -|---|---|---| -|**isDefault**
*optional*|Information calculated from parameter default in the Tosca file|boolean| -|**value**
*optional*|A discrete value that the characteristic can take on|string| -|**valueType**
*optional*|A kind of value that the characteristic can take on, such as numeric, text, and so forth
Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type.
We do not manage parameter_type= list or map for Beijing release|string| - - - -### ServiceSpecification -ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. -the service information are retrieved in SDC - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*|Not used for Beijing release|string| -|**@schemaLocation**
*optional*|Not used for Beijing release|string| -|**@type**
*optional*|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:
invariantUUID
toscaModelURL
toscaResourceName
category (1)
subcategory (1)
distributionStatus
**Default** : `"ONAPservice"`|string| -|**attachment**
*optional*||< [Attachment](#attachment) > array| -|**category**
*optional*|Additional attribute - extended through @type - category
Please note that this attribute is managed in TMF - in future release we'll introduce category resource|string| -|**description**
*optional*|A narrative that explains in detail what the service specification is - Filled with SDC Service description|string| -|**distributionStatus**
*optional*||[DistributionStatus](#distributionstatus)| -|**href**
*optional*|Reference of the service specification- not mapped in Beijing|string| -|**id**
*optional*|Unique identifier of the service specification. Filled with SDC Service uuid|string| -|**invariantUUID**
*required*|Additional attribute (not in the TMF API) - extended through @type - invariantUUID|string| -|**lifecycleStatus**
*optional*||[LifecycleStatusValues](#lifecyclestatusvalues)| -|**name**
*optional*|Name of the service specification- Filled with SDC Service name|string| -|**relatedParty**
*optional*||< [RelatedPartyRef](#relatedpartyref) > array| -|**resourceSpecification**
*optional*||< [ResourceSpecificationRef](#resourcespecificationref) > array| -|**serviceSpecCharacteristic**
*optional*||< [ServiceSpecCharacteristic](#servicespeccharacteristic) > array| -|**subcategory**
*optional*|Additional attribute - extended through @type - category
Please note that this attribute is managed in TMF - in future release we'll introduce category resourc|string| -|**targetServiceSchema**
*optional*||[TargetServiceSchemaRef](#targetserviceschemaref)| -|**toscaModelURL**
*optional*|Additional attribute (not in the TMF API) - extended through @type - toscaModelURL|string| -|**toscaResourceName**
*optional*|Additional attribute (not in the TMF API) - extended through @type - toscaResourceName|string| -|**version**
*optional*|Service specification version - Filled with SDC Service version|string| - - - -### TargetServiceSchemaRef - -|Name|Schema| -|---|---| -|**@schemaLocation**
*required*|string| -|**@type**
*required*|string| - - - -### TimePeriod -A time period - - -|Name|Description|Schema| -|---|---|---| -|**endDateTime**
*optional*|End date and time of the period|string (date-time)| -|**startDateTime**
*optional*|Start date and time of the period|string (date-time)| - diff --git a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml deleted file mode 100644 index 2c08be7..0000000 --- a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml +++ /dev/null @@ -1,89 +0,0 @@ -@startuml - - -class ErrorRepresentation { - code:int - reason:string - message:string - status:string - referenceError:string - @type:string - @schemaLocation:string -} - -class Service { - id:string - href:string - name:string - type:string - state:string - hasStarted:boolean - @type:string - @baseType:string - @schemaLocation:string -} - Service --> "0-1" ServiceSpecificationRef : serviceSpecification - Service --> "0-*" ServiceCharacteristic : characteristic - Service --> "0-*" SupportingResource : supportingResource - Service --> "0-*" RelatedPartyRef : relatedParty - -class ServiceSpecificationRef { - id:string - href:string - name:string - version:string - @referredType:string - @schemaLocation:string - invariantUUID:string -} - -class ServiceCharacteristic { - name:string - valueType:string -} - ServiceCharacteristic --> "0-1" Value : value - -class SupportingResource { - id:string - href:string - role:string - name:string - @referredType:string - @schemaLocation:string - status:string - modelInvariantId:string - modelVersionId:string - modelCustomisationId:string -} - -class RelatedPartyRef { - id:string - href:string - role:string - @referredType:string -} - -class Value { - @type:string - @schemaLocation:string - serviceCharacteristicValue:string -} - -class ListRelatedPartyRef { - id:string - role:string -} - -class ListServiceSpecificationRef { - id:string - name:string -} - -class ListService { - id:string - name:string -} - ListService --> "0-1" ListServiceSpecificationRef : serviceSpecification - ListService --> "0-1" ListRelatedPartyRef : relatedParty - -@enduml \ No newline at end of file diff --git a/docs/offeredapis/serviceInventory/asciiDoc.adoc b/docs/offeredapis/serviceInventory/asciiDoc.adoc deleted file mode 100644 index e34ec44..0000000 --- a/docs/offeredapis/serviceInventory/asciiDoc.adoc +++ /dev/null @@ -1,461 +0,0 @@ -= API ServiceInventory - - -[[_overview]] -== Overview - -=== Api URL - -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json[Swagger UI] - - -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0[plant UML UI] - -serviceInventory API designed for ONAP Beijing Release. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0) -only operation GET (by id & byList) for resource serviceSpecification is available - - -=== Version information -[%hardbreaks] -__Version__ : 3.0.0_inProgress - - -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /nbi/api/v3 -__Schemes__ : HTTPS - - -=== Tags - -* Service - - -=== Produces - -* `application/json;charset=utf-8` - - -[[_paths]] -== Resources - -[[_service_resource]] -=== Service - -[[_servicefind]] -==== List services -.... -GET /service -.... - - -===== Description -This operation list service entities. -Attribute selection is restricted. -fields attribute may be used to filter retrieved attribute(s) for each service - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Query**|**fields** + -__optional__|string -|**Query**|**id** + -__optional__|string -|**Query**|**relatedParty.id** + -__optional__|string -|**Query**|**serviceSpecification.id** + -__optional__|string -|**Query**|**serviceSpecification.name** + -__optional__|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|< <<_listservice,ListService>> > array -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_serviceget]] -==== Retrieve a service -.... -GET /service/{id} -.... - - -===== Description -This operation retrieves a service entity. -Attribute selection is enabled for all first level attributes. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Path**|**id** + -__required__|string -|**Query**|**relatedParty.id** + -__optional__|string -|**Query**|**serviceSpecification.id** + -__optional__|string -|**Query**|**serviceSpecification.name** + -__optional__|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|<<_service,Service>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_definitions]] -== Definitions - -[[_errorrepresentation]] -=== ErrorRepresentation -This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|it provides a link to the schema describing a REST resource.|string -|**@type** + -__optional__|The class type of a REST resource.|string -|**code** + -__required__|Application related code (as defined in the API or from a common list)|integer (int32) -|**message** + -__optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user.|string -|**reason** + -__required__|Text that explains the reason for error. This can be shown to a client user.|string -|**referenceError** + -__optional__|url pointing to documentation describing the error|string -|**status** + -__optional__|http error code extension like 400-2|string -|=== - - -[[_listrelatedpartyref]] -=== ListRelatedPartyRef -This class is used to structure list of service(s) retrieved - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**id** + -__optional__|Unique identifier of a related party|string -|**role** + -__optional__|Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.|string -|=== - - -[[_listservice]] -=== ListService -This class is used to structure list of service(s) retrieved - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**id** + -__optional__|Unique identifier of the service|string -|**name** + -__optional__|Name of the service|string -|**relatedParty** + -__optional__||<<_listrelatedpartyref,ListRelatedPartyRef>> -|**serviceSpecification** + -__optional__||<<_listservicespecificationref,ListServiceSpecificationRef>> -|=== - - -[[_listservicespecificationref]] -=== ListServiceSpecificationRef -This class is used to structure list of service(s) retrieved - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**id** + -__optional__|Unique identifier of the service specification|string -|**name** + -__optional__|Name of the required service specification|string -|=== - - -[[_relatedpartyref]] -=== RelatedPartyRef -RelatedParty reference. A related party defines party or party role linked to a specific entity. -Only ONAP Customer is managed in Beijing release. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@referredType** + -__optional__|Not managed in the Beijing release.|string -|**href** + -__optional__|Reference of a related party. -Not filled in Beijing release.|string -|**id** + -__optional__|Unique identifier of a related party|string -|**role** + -__optional__|Role played by the related party. -Filled with 'ONAPcustomer'|string -|=== - - -[[_service]] -=== Service -Instantiated service (service_instance) in AAI - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__|Not managed in Beijing release|string -|**@schemaLocation** + -__optional__|Not managed in Beijing release|string -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Not used in Beijing release.|string -|**characteristic** + -__optional__||< <<_servicecharacteristic,ServiceCharacteristic>> > array -|**hasStarted** + -__optional__|This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started -Not managed in Beijing release|boolean -|**href** + -__optional__|Reference of the service -Not managed in Beijing release|string -|**id** + -__optional__|Unique identifier of the service - Valued with service-instance-id|string -|**name** + -__optional__|Name of the service - Valued with service-instance-name|string -|**relatedParty** + -__optional__||< <<_relatedpartyref,RelatedPartyRef>> > array -|**serviceSpecification** + -__optional__||<<_servicespecificationref,ServiceSpecificationRef>> -|**state** + -__optional__|State of the service. Not managed in Beijing release|string -|**supportingResource** + -__optional__||< <<_supportingresource,SupportingResource>> > array -|**type** + -__optional__|Service type - valued with 'service-instance'|string -|=== - - -[[_servicecharacteristic]] -=== ServiceCharacteristic -A list of name value pairs that define the service characteristics -Not managed in Beijing release. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**name** + -__required__|Name of the characteristic -Not managed in Beijing release.|string -|**value** + -__optional__||<<_value,Value>> -|**valueType** + -__optional__|Type of value for this characteristic. -Not managed in Beijing release.|string -|=== - - -[[_servicespecificationref]] -=== ServiceSpecificationRef -Service specification reference: ServiceSpecification of this service (catalog information) - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@referredType** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID|string -|**@schemaLocation** + -__optional__|Not managed in Beijing release|string -|**href** + -__optional__|Reference of the service specification. -not managed in Beijing release.|string -|**id** + -__optional__|Unique identifier of the service specification. valued to model-version-id|string -|**invariantUUID** + -__optional__|Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id|string -|**name** + -__optional__|Name of the required service specification|string -|**version** + -__optional__|Service specification version. -Not managed in Beijing release|string -|=== - - -[[_supportingresource]] -=== SupportingResource -Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@referredType** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes: - status - modelInvariantId - modelVersionId - modelCustomisationId|string -|**@schemaLocation** + -__optional__|Not managed in Beijing release.|string -|**href** + -__optional__|Reference of the supporting resource|string -|**id** + -__optional__|Unique identifier of the supporting resource - Valued to vnf-id|string -|**modelCustomisationId** + -__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id|string -|**modelInvariantId** + -__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id|string -|**modelVersionId** + -__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id|string -|**name** + -__optional__|Name of the supporting resource - Valued with vnf_-name|string -|**role** + -__optional__|Not managed in Beijing release.|string -|**status** + -__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status|string -|=== - - -[[_value]] -=== Value -Structure used to describe characteristic value. -Not managed in Beijing release. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|Not managed in Beijing release.|string -|**@type** + -__optional__|Not managed in Beijing release.|string -|**serviceCharacteristicValue** + -__optional__|Not managed in Beijing release.|string -|=== - diff --git a/docs/offeredapis/serviceInventory/documentation.html b/docs/offeredapis/serviceInventory/documentation.html deleted file mode 100644 index f7fb115..0000000 --- a/docs/offeredapis/serviceInventory/documentation.html +++ /dev/null @@ -1,1432 +0,0 @@ - - - - - - - -API ServiceInventory - - - - - -
-
-

Overview

-
-
-

Api URL

-
-

Swagger UI

-
-
-

plant UML UI

-
-
-

serviceInventory API designed for ONAP Beijing Release. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0) -only operation GET (by id & byList) for resource serviceSpecification is available

-
-
-
-

Version information

-
-

Version : 3.0.0_inProgress

-
-
-
-

URI scheme

-
-

Host : serverRoot
-BasePath : /nbi/api/v3
-Schemes : HTTPS

-
-
-
-

Tags

-
-
    -
  • -

    Service

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-

Resources

-
-
-

Service

-
-

List services

-
-
-
GET /service
-
-
-
-
Description
-
-

This operation list service entities. -Attribute selection is restricted. -fields attribute may be used to filter retrieved attribute(s) for each service

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameSchema

Query

fields
-optional

string

Query

id
-optional

string

Query

relatedParty.id
-optional

string

Query

serviceSpecification.id
-optional

string

Query

serviceSpecification.name
-optional

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

< ListService > array

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Retrieve a service

-
-
-
GET /service/{id}
-
-
-
-
Description
-
-

This operation retrieves a service entity. -Attribute selection is enabled for all first level attributes.

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameSchema

Path

id
-required

string

Query

relatedParty.id
-optional

string

Query

serviceSpecification.id
-optional

string

Query

serviceSpecification.name
-optional

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

Service

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-
-
-

Definitions

-
-
-

ErrorRepresentation

-
-

This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

it provides a link to the schema describing a REST resource.

string

@type
-optional

The class type of a REST resource.

string

code
-required

Application related code (as defined in the API or from a common list)

integer (int32)

message
-optional

Text that provide more details and corrective actions related to the error. This can be shown to a client user.

string

reason
-required

Text that explains the reason for error. This can be shown to a client user.

string

referenceError
-optional

url pointing to documentation describing the error

string

status
-optional

http error code extension like 400-2

string

-
-
-

ListRelatedPartyRef

-
-

This class is used to structure list of service(s) retrieved

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of a related party

string

role
-optional

Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.

string

-
-
-

ListService

-
-

This class is used to structure list of service(s) retrieved

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of the service

string

name
-optional

Name of the service

string

relatedParty
-optional

ListRelatedPartyRef

serviceSpecification
-optional

ListServiceSpecificationRef

-
-
-

ListServiceSpecificationRef

-
-

This class is used to structure list of service(s) retrieved

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of the service specification

string

name
-optional

Name of the required service specification

string

-
-
-

RelatedPartyRef

-
-

RelatedParty reference. A related party defines party or party role linked to a specific entity. -Only ONAP Customer is managed in Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

Not managed in the Beijing release.

string

href
-optional

Reference of a related party. -Not filled in Beijing release.

string

id
-optional

Unique identifier of a related party

string

role
-optional

Role played by the related party. -Filled with 'ONAPcustomer'

string

-
-
-

Service

-
-

Instantiated service (service_instance) in AAI

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

Not managed in Beijing release

string

@schemaLocation
-optional

Not managed in Beijing release

string

@type
-optional

This attribute allows to dynamically extends TMF class. Not used in Beijing release.

string

characteristic
-optional

< ServiceCharacteristic > array

hasStarted
-optional

This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started -Not managed in Beijing release

boolean

href
-optional

Reference of the service -Not managed in Beijing release

string

id
-optional

Unique identifier of the service - Valued with service-instance-id

string

name
-optional

Name of the service - Valued with service-instance-name

string

relatedParty
-optional

< RelatedPartyRef > array

serviceSpecification
-optional

ServiceSpecificationRef

state
-optional

State of the service. Not managed in Beijing release

string

supportingResource
-optional

< SupportingResource > array

type
-optional

Service type - valued with 'service-instance'

string

-
-
-

ServiceCharacteristic

-
-

A list of name value pairs that define the service characteristics -Not managed in Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

name
-required

Name of the characteristic -Not managed in Beijing release.

string

value
-optional

Value

valueType
-optional

Type of value for this characteristic. -Not managed in Beijing release.

string

-
-
-

ServiceSpecificationRef

-
-

Service specification reference: ServiceSpecification of this service (catalog information)

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID

string

@schemaLocation
-optional

Not managed in Beijing release

string

href
-optional

Reference of the service specification. -not managed in Beijing release.

string

id
-optional

Unique identifier of the service specification. valued to model-version-id

string

invariantUUID
-optional

Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id

string

name
-optional

Name of the required service specification

string

version
-optional

Service specification version. -Not managed in Beijing release

string

-
-
-

SupportingResource

-
-

Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes: - status - modelInvariantId - modelVersionId - modelCustomisationId

string

@schemaLocation
-optional

Not managed in Beijing release.

string

href
-optional

Reference of the supporting resource

string

id
-optional

Unique identifier of the supporting resource - Valued to vnf-id

string

modelCustomisationId
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id

string

modelInvariantId
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id

string

modelVersionId
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id

string

name
-optional

Name of the supporting resource - Valued with vnf_-name

string

role
-optional

Not managed in Beijing release.

string

status
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status

string

-
-
-

Value

-
-

Structure used to describe characteristic value. -Not managed in Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

Not managed in Beijing release.

string

@type
-optional

Not managed in Beijing release.

string

serviceCharacteristicValue
-optional

Not managed in Beijing release.

string

-
-
-
-
- - - \ No newline at end of file diff --git a/docs/offeredapis/serviceInventory/markDown.md b/docs/offeredapis/serviceInventory/markDown.md deleted file mode 100644 index c65263b..0000000 --- a/docs/offeredapis/serviceInventory/markDown.md +++ /dev/null @@ -1,287 +0,0 @@ -# API ServiceInventory - - - -## Overview - -### Api URL - -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json) - - -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0) - -serviceInventory API designed for ONAP Beijing Release. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0) -only operation GET (by id & byList) for resource serviceSpecification is available - - -### Version information -*Version* : 3.0.0_inProgress - - -### URI scheme -*Host* : serverRoot -*BasePath* : /nbi/api/v3 -*Schemes* : HTTPS - - -### Tags - -* Service - - -### Produces - -* `application/json;charset=utf-8` - - - -## Resources - - -### Service - - -#### List services -``` -GET /service -``` - - -##### Description -This operation list service entities. -Attribute selection is restricted. -fields attribute may be used to filter retrieved attribute(s) for each service - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Query**|**fields**
*optional*|string| -|**Query**|**id**
*optional*|string| -|**Query**|**relatedParty.id**
*optional*|string| -|**Query**|**serviceSpecification.id**
*optional*|string| -|**Query**|**serviceSpecification.name**
*optional*|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|< [ListService](#listservice) > array| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -#### Retrieve a service -``` -GET /service/{id} -``` - - -##### Description -This operation retrieves a service entity. -Attribute selection is enabled for all first level attributes. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Path**|**id**
*required*|string| -|**Query**|**relatedParty.id**
*optional*|string| -|**Query**|**serviceSpecification.id**
*optional*|string| -|**Query**|**serviceSpecification.name**
*optional*|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|[Service](#service)| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -## Definitions - - -### ErrorRepresentation -This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|it provides a link to the schema describing a REST resource.|string| -|**@type**
*optional*|The class type of a REST resource.|string| -|**code**
*required*|Application related code (as defined in the API or from a common list)|integer (int32)| -|**message**
*optional*|Text that provide more details and corrective actions related to the error. This can be shown to a client user.|string| -|**reason**
*required*|Text that explains the reason for error. This can be shown to a client user.|string| -|**referenceError**
*optional*|url pointing to documentation describing the error|string| -|**status**
*optional*|http error code extension like 400-2|string| - - - -### ListRelatedPartyRef -This class is used to structure list of service(s) retrieved - - -|Name|Description|Schema| -|---|---|---| -|**id**
*optional*|Unique identifier of a related party|string| -|**role**
*optional*|Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.|string| - - - -### ListService -This class is used to structure list of service(s) retrieved - - -|Name|Description|Schema| -|---|---|---| -|**id**
*optional*|Unique identifier of the service|string| -|**name**
*optional*|Name of the service|string| -|**relatedParty**
*optional*||[ListRelatedPartyRef](#listrelatedpartyref)| -|**serviceSpecification**
*optional*||[ListServiceSpecificationRef](#listservicespecificationref)| - - - -### ListServiceSpecificationRef -This class is used to structure list of service(s) retrieved - - -|Name|Description|Schema| -|---|---|---| -|**id**
*optional*|Unique identifier of the service specification|string| -|**name**
*optional*|Name of the required service specification|string| - - - -### RelatedPartyRef -RelatedParty reference. A related party defines party or party role linked to a specific entity. -Only ONAP Customer is managed in Beijing release. - - -|Name|Description|Schema| -|---|---|---| -|**@referredType**
*optional*|Not managed in the Beijing release.|string| -|**href**
*optional*|Reference of a related party.
Not filled in Beijing release.|string| -|**id**
*optional*|Unique identifier of a related party|string| -|**role**
*optional*|Role played by the related party.
Filled with 'ONAPcustomer'|string| - - - -### Service -Instantiated service (service_instance) in AAI - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*|Not managed in Beijing release|string| -|**@schemaLocation**
*optional*|Not managed in Beijing release|string| -|**@type**
*optional*|This attribute allows to dynamically extends TMF class. Not used in Beijing release.|string| -|**characteristic**
*optional*||< [ServiceCharacteristic](#servicecharacteristic) > array| -|**hasStarted**
*optional*|This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started
Not managed in Beijing release|boolean| -|**href**
*optional*|Reference of the service
Not managed in Beijing release|string| -|**id**
*optional*|Unique identifier of the service - Valued with service-instance-id|string| -|**name**
*optional*|Name of the service - Valued with service-instance-name|string| -|**relatedParty**
*optional*||< [RelatedPartyRef](#relatedpartyref) > array| -|**serviceSpecification**
*optional*||[ServiceSpecificationRef](#servicespecificationref)| -|**state**
*optional*|State of the service. Not managed in Beijing release|string| -|**supportingResource**
*optional*||< [SupportingResource](#supportingresource) > array| -|**type**
*optional*|Service type - valued with 'service-instance'|string| - - - -### ServiceCharacteristic -A list of name value pairs that define the service characteristics -Not managed in Beijing release. - - -|Name|Description|Schema| -|---|---|---| -|**name**
*required*|Name of the characteristic
Not managed in Beijing release.|string| -|**value**
*optional*||[Value](#value)| -|**valueType**
*optional*|Type of value for this characteristic.
Not managed in Beijing release.|string| - - - -### ServiceSpecificationRef -Service specification reference: ServiceSpecification of this service (catalog information) - - -|Name|Description|Schema| -|---|---|---| -|**@referredType**
*optional*|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID|string| -|**@schemaLocation**
*optional*|Not managed in Beijing release|string| -|**href**
*optional*|Reference of the service specification.
not managed in Beijing release.|string| -|**id**
*optional*|Unique identifier of the service specification. valued to model-version-id|string| -|**invariantUUID**
*optional*|Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id|string| -|**name**
*optional*|Name of the required service specification|string| -|**version**
*optional*|Service specification version.
Not managed in Beijing release|string| - - - -### SupportingResource -Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf - - -|Name|Description|Schema| -|---|---|---| -|**@referredType**
*optional*|This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:
status
modelInvariantId
modelVersionId
modelCustomisationId|string| -|**@schemaLocation**
*optional*|Not managed in Beijing release.|string| -|**href**
*optional*|Reference of the supporting resource|string| -|**id**
*optional*|Unique identifier of the supporting resource - Valued to vnf-id|string| -|**modelCustomisationId**
*optional*|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id|string| -|**modelInvariantId**
*optional*|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id|string| -|**modelVersionId**
*optional*|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id|string| -|**name**
*optional*|Name of the supporting resource - Valued with vnf_-name|string| -|**role**
*optional*|Not managed in Beijing release.|string| -|**status**
*optional*|Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status|string| - - - -### Value -Structure used to describe characteristic value. -Not managed in Beijing release. - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|Not managed in Beijing release.|string| -|**@type**
*optional*|Not managed in Beijing release.|string| -|**serviceCharacteristicValue**
*optional*|Not managed in Beijing release.|string| - diff --git a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml deleted file mode 100644 index 775fdeb..0000000 --- a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml +++ /dev/null @@ -1,242 +0,0 @@ -@startuml - -enum ActionType { - add - modify - delete - noChange -} -enum StateType { - acknowledged - rejected - pending - held - inProgress - cancelled - completed - failed - partial -} -enum RelationshipType { - reliesOn -} -enum EventType { - ServiceOrderCreationNotification - ServiceOrderStateChangeNotification - ServiceOrderItemStateChangeNotification -} -enum SeverityMessage { - information - error -} - -class ErrorRepresentation { - code:int - reason:string - message:string - status:string - referenceError:string - @type:string - @schemaLocation:string -} - -class ServiceRelationship - ServiceRelationship --> "1-1" RelationshipType : type - ServiceRelationship --> "1-1" Service : service - -class ServiceRef { - id:string - href:string -} - -class ServiceCharacteristic { - name:string - valueType:string -} - ServiceCharacteristic --> "0-1" Value : value - -class RelatedParty { - id:string - href:string - role:string - name:string - @referredType:string -} - -class ServiceSpecificationRef { - id:string - href:string - name:string - version:string - @type:string - @schemaLocation:string - @baseType:string -} - ServiceSpecificationRef --> "0-1" TargetServiceSchema : targetServiceSchema - -class Service { - id:string - href:string - name:string - serviceState:string - @type:string - @schemaLocation:string -} - Service --> "0-*" ServiceCharacteristic : serviceCharacteristic - Service --> "0-*" ServiceRelationship : serviceRelationship - Service --> "0-*" RelatedParty : relatedParty - Service --> "0-1" ServiceSpecificationRef : serviceSpecification - -class OrderItemRelationship { - id:string -} - OrderItemRelationship --> "1-1" RelationshipType : type - -class ServiceOrderItem { - id:string - percentProgress:string - @type:string - @schemaLocation:string - @baseType:string -} - ServiceOrderItem --> "0-1" ActionType : action - ServiceOrderItem --> "0-1" StateType : state - ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship - ServiceOrderItem --> "1-1" Service : service - ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage - -class ServiceOrder { - id:string - href:string - externalId:string - priority:string - description:string - category:string - orderDate:dateTime - completionDateTime:dateTime - requestedStartDate:dateTime - requestedCompletionDate:dateTime - expectedCompletionDate:dateTime - startDate:dateTime - @baseType:string - @type:string - @schemaLocation:string -} - ServiceOrder --> "0-1" StateType : state - ServiceOrder --> "0-*" RelatedParty : relatedParty - ServiceOrder --> "0-*" OrderRelationship : orderRelationship - ServiceOrder --> "0-*" ServiceOrderItem : orderItem - ServiceOrder --> "0-*" OrderMessage : orderMessage - -class OrderRelationship { - type:string - id:string - href:string - @referredType:string -} - -class TargetServiceSchema { - @type:string - @schemaLocation:string -} - -class Value { - @type:string - @schemaLocation:string - serviceCharacteristicValue:string -} - -class CreateServiceOrderItem { - id:string - @type:string - @schemaLocation:string - @baseType:string -} - CreateServiceOrderItem --> "0-1" ActionType : action - CreateServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship - CreateServiceOrderItem --> "1-1" Service : service - -class CreateServiceOrder { - externalId:string - priority:string - description:string - category:string - requestedStartDate:dateTime - requestedCompletionDate:dateTime - @baseType:string - @type:string - @schemaLocation:string -} - CreateServiceOrder --> "0-*" RelatedParty : relatedParty - CreateServiceOrder --> "0-*" OrderRelationship : orderRelationship - CreateServiceOrder --> "0-*" CreateServiceOrderItem : orderItem - -class Hub { - id:string - query:string - callback:string -} - -class CreateHub { - query:string - callback:string -} - -class ServiceOrderSummary { - id:string - href:string - externalId:string - orderDate:dateTime - completionDateTime:dateTime -} - ServiceOrderSummary --> "0-1" StateType : state - -class ServiceOrderCreationNotification { - eventId:string - eventDate:dateTime - eventType:string -} - ServiceOrderCreationNotification --> "1-1" ServiceOrderSummary : event - -class Notification - -class ServiceOrderStateChangeNotification { - eventId:string - eventDate:dateTime - eventType:string -} - ServiceOrderStateChangeNotification --> "1-1" ServiceOrderSummary : event - -class ServiceOrderItemSummary { - id:string -} - ServiceOrderItemSummary --> "0-1" ActionType : action - ServiceOrderItemSummary --> "0-1" StateType : state - ServiceOrderItemSummary --> "1-1" Service : service - -class ServiceOrderSummaryWithItem { - id:string - href:string - externalId:string - orderDate:dateTime - completionDateTime:dateTime -} - ServiceOrderSummaryWithItem --> "0-1" StateType : state - ServiceOrderSummaryWithItem --> "0-*" ServiceOrderItemSummary : orderItem - -class ServiceOrderItemStateChangeNotification { - eventId:string - eventDate:dateTime - eventType:string -} - ServiceOrderItemStateChangeNotification --> "1-1" ServiceOrderSummaryWithItem : event - -class OrderMessage { - code:string - field:string - messageInformation:string - correctionRequired:boolean -} - OrderMessage --> "1-1" SeverityMessage : severity - -@enduml \ No newline at end of file diff --git a/docs/offeredapis/serviceOrder/asciiDoc.adoc b/docs/offeredapis/serviceOrder/asciiDoc.adoc deleted file mode 100644 index 72ba736..0000000 --- a/docs/offeredapis/serviceOrder/asciiDoc.adoc +++ /dev/null @@ -1,1512 +0,0 @@ -= API ServiceOrder - - -[[_overview]] -== Overview - -=== Api URL - -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json[Swagger UI] - - -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0[plant UML UI] - -serviceOrder API designed for ONAP. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0); -Only operations GET (by id and list) and POST are available. - - -=== Version information -[%hardbreaks] -__Version__ : 3.0.0_inProgress - - -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /nbi/api/v3 -__Schemes__ : HTTPS - - -=== Tags - -* Hub -* Notification -* ServiceOrder : A 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. - - -=== Produces - -* `application/json;charset=utf-8` - - -[[_paths]] -== Resources - -[[_hub_resource]] -=== Hub - -[[_hubcreate]] -==== Create Hub -.... -POST /hub -.... - - -===== Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Body**|**Hub** + -__required__|<<_createhub,CreateHub>> -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**201**|Success + -**Headers** : + -`location` (string)|file -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Consumes - -* `application/json;charset=utf-8` - - -[[_hubfind]] -==== Retrieve a lits of hub -.... -GET /hub -.... - - -===== Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Query**|**eventType** + -__optional__|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) -|**Query**|**id** + -__optional__|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|< <<_hub,Hub>> > array -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_hubget]] -==== Retrieve an HUB by id -.... -GET /hub/{hubId} -.... - - -===== Description -Retrieve an HUB by id - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Path**|**hubId** + -__required__|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|<<_hub,Hub>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_hubdelete]] -==== delete hub -.... -DELETE /hub/{hubId} -.... - - -===== Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Path**|**hubId** + -__required__|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**204**|Success|No Content -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -[[_notification_resource]] -=== Notification - -[[_notificationserviceordercreationnotification]] -==== Service order creation notification -.... -POST /notification/serviceOrderCreationNotification -.... - - -===== Description -Service order creation notification - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Body**|**serviceOrderCreationNotification** + -__required__|<<_serviceordercreationnotification,ServiceOrderCreationNotification>> -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**204**|Success|No Content -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Consumes - -* `application/json;charset=utf-8` - - -[[_notificationserviceorderitemstatechangenotification]] -==== ServiceOrder Item State Change Notification description -.... -POST /notification/serviceOrderItemStateChangeNotification -.... - - -===== Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Body**|**serviceOrderItemStateChangeNotification** + -__required__|<<_serviceorderitemstatechangenotification,ServiceOrderItemStateChangeNotification>> -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**204**|Success|No Content -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Consumes - -* `application/json;charset=utf-8` - - -[[_notificationserviceorderstatechangenotification]] -==== Service order state change notification description -.... -POST /notification/serviceOrderStateChangeNotification -.... - - -===== Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Body**|**serviceOrderstateChangeNotification** + -__required__|<<_serviceorderstatechangenotification,ServiceOrderStateChangeNotification>> -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**204**|Success|No Content -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Consumes - -* `application/json;charset=utf-8` - - -[[_serviceorder_resource]] -=== ServiceOrder -A 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. - - -[[_serviceordercreate]] -==== Create a service order -.... -POST /serviceOrder -.... - - -===== Description -This operation creates a service order entity. -The 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. -POST 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. - -In 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. - -In 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. -Depending 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. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - -* 100: OrderItem with 'add' action but serviceSpecification id missing - -* 101: OrderItem with 'change'/'noChange'/'remove' but service id missing - -* 102: OrderItem with 'add' action - serviceSpecification id provided but not existing - -* 103: OrderItem with 'add' action but service id already existing in the inventory - -* 104: A customer for existing service(s) is provided but he did not exist - -* 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory - -* 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided - - -===== Parameters - -[options="header", cols=".^2,.^3,.^4"] -|=== -|Type|Name|Schema -|**Body**|**serviceOrder** + -__required__|<<_createserviceorder,CreateServiceOrder>> -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**201**|Success|<<_serviceorder,ServiceOrder>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error - -Specific encapsulated business errors for current operation - -* 100: OrderItem with 'add' action but serviceSpecification id missing - -* 101: OrderItem with 'change'/'noChange'/'remove' but service id missing - -* 102: OrderItem with 'add' action - serviceSpecification id provided but not existing - -* 103: OrderItem with 'add' action but service id already existing in the inventory - -* 104: A customer for existing service(s) is provided but he did not exist - -* 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory - -* 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Consumes - -* `application/json;charset=utf-8` - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_serviceorderfind]] -==== List service orders -.... -GET /serviceOrder -.... - - -===== Description -Retrieve and list service order entities according to given criteria. -Only a predefined set of attribute is proposed. -Attribute selection could be described in the fields attribute. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4"] -|=== -|Type|Name|Description|Schema -|**Query**|**description** + -__optional__||string -|**Query**|**externalId** + -__optional__||string -|**Query**|**fields** + -__optional__|this attribute could be used to filter retrieved attribute(s) and/or sort SO.|string -|**Query**|**limit** + -__optional__|The maximum number of elements to retrieve (it can be greater than the actual available number of items).|integer (int32) -|**Query**|**offset** + -__optional__|The index of the first element to retrieve. Zero is the first element of the collection.|integer (int32) -|**Query**|**orderDate.gt** + -__optional__|order date greather than|string -|**Query**|**orderDate.lt** + -__optional__|order date lower than|string -|**Query**|**state** + -__optional__|state of the order(s) to be retrieved|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success + -**Headers** : + -`X-Total-Count` (integer (int32)) + -`X-Result-Count` (integer (int32))|< <<_serviceorder,ServiceOrder>> > array -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_serviceorderget]] -==== Retrieve a service order -.... -GET /serviceOrder/{id} -.... - - -===== Description -This operation retrieves a service order entity. -Attribute selection is enabled for all first level attributes. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4"] -|=== -|Type|Name|Description|Schema -|**Path**|**id** + -__required__||string -|**Query**|**fields** + -__optional__|Attribute selection|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|<<_serviceorder,ServiceOrder>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_definitions]] -== Definitions - -[[_actiontype]] -=== ActionType -Action type to be describer on the order item. -modify is not managed in Beijing release - -__Type__ : enum (add, modify, delete, noChange) - - -[[_createhub]] -=== CreateHub -This structure is used as a request for POST Hub operation - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**callback** + -__required__|Address where notification must be send|string -|**query** + -__required__|The query must have an eventType=notificationName information. -Optionally a ? could be added to reduce hub. -query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string -|=== - - -[[_createserviceorder]] -=== CreateServiceOrder -This structure is used in the operation POST for a serviceOrder request. -Attribute description is not accurate and should be find in the serviceOrder class. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__||string -|**@schemaLocation** + -__optional__||string -|**@type** + -__optional__||string -|**category** + -__optional__|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)|string -|**description** + -__optional__|A free-text description of the service order|string -|**externalId** + -__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string -|**orderItem** + -__optional__||< <<_createserviceorderitem,CreateServiceOrderItem>> > array -|**orderRelationship** + -__optional__||< <<_orderrelationship,OrderRelationship>> > array -|**priority** + -__optional__|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string -|**relatedParty** + -__optional__||< <<_relatedparty,RelatedParty>> > array -|**requestedCompletionDate** + -__optional__|Requested delivery date from the requestor perspective|string (date-time) -|**requestedStartDate** + -__optional__|Order start date wished by the requestor|string (date-time) -|=== - - -[[_createserviceorderitem]] -=== CreateServiceOrderItem -This structure is used in the operation POST for a serviceOrder request to describe an item. -Attribute description is not accurate and should be find in the serviceOrderItem class. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__|Indicates the base type of the resource.|string -|**@schemaLocation** + -__optional__|A link to the schema describing this REST resource|string -|**@type** + -__optional__|Indicates the type of resource.|string -|**action** + -__optional__||<<_actiontype,ActionType>> -|**id** + -__required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string -|**orderItemRelationship** + -__optional__||< <<_orderitemrelationship,OrderItemRelationship>> > array -|**service** + -__required__||<<_service,Service>> -|=== - - -[[_errorrepresentation]] -=== ErrorRepresentation -Representation of an error. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|it provides a link to the schema describing a REST resource|string -|**@type** + -__optional__|The class type of a REST resource|string -|**code** + -__required__|Application related code (as defined in the API or from a common list)|integer (int32) -|**message** + -__optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string -|**reason** + -__required__|Text that explains the reason for error. This can be shown to a client user.|string -|**referenceError** + -__optional__|url pointing to documentation describing the error|string -|**status** + -__optional__|http error code extension like 400-2|string -|=== - - -[[_eventtype]] -=== EventType -__Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) - - -[[_hub]] -=== Hub -An HUB resource is used by client side to subscribe to notification. -Not managed in the Beijing release. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**callback** + -__required__|Address where notification must be send|string -|**id** + -__optional__|Hub Id|string -|**query** + -__required__||string -|=== - - -[[_notification]] -=== Notification -Used to describe notification for this API - -__Type__ : object - - -[[_orderitemrelationship]] -=== OrderItemRelationship -Linked order item to the one containing this attribute. -nbi component used this relationship to sort request to ONAP. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**id** + -__required__|Unique identifier of an order item|string -|**type** + -__required__||<<_relationshiptype,RelationshipType>> -|=== - - -[[_ordermessage]] -=== OrderMessage -An optional array of messages associated with the Order - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**code** + -__optional__|A code associated to this message|string -|**correctionRequired** + -__required__|Indicator that an action is required to allow service order fullfilment to follow up|boolean -|**field** + -__optional__|Service Order attribute related to this error message|string -|**messageInformation** + -__optional__|Message related to this order|string -|**severity** + -__required__||<<_severitymessage,SeverityMessage>> -|=== - - -[[_orderrelationship]] -=== OrderRelationship -Linked order to the one containing this attribute. -This relationship is not used to sort ONAP request. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@referredType** + -__optional__|Type of the referred order.|string -|**href** + -__optional__|A hyperlink to the related order|string -|**id** + -__required__|The id of the related order|string -|**type** + -__optional__|The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)|string -|=== - - -[[_relatedparty]] -=== RelatedParty -A related party defines party which are involved in this order and the role they are playing. -for Beijing release: -With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information: -o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not. -o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@referredType** + -__optional__||string -|**href** + -__optional__|An hyperlink to the party - not used in Beijnig release|string -|**id** + -__required__|Unique identifier of a related party|string -|**name** + -__optional__|Name of the related party|string -|**role** + -__required__|The role of the related party (e.g. Owner, requester, fullfiller etc). -ONLY 'ONAPcustomer' is considered|string -|=== - - -[[_relationshiptype]] -=== RelationshipType -Relationship type; -Only reliesOn is managed in Beijing release. - -__Type__ : enum (reliesOn) - - -[[_service]] -=== Service -Service (to be added, modified, deleted) description - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|The URL to get the resource schema. -Not managed in Beijing Release|string -|**@type** + -__optional__|To define the service type -Not managed in Beijing Release|string -|**href** + -__optional__|Reference to the Service (useful for delete or modify command). -Not managed in Beijing release.|string -|**id** + -__required__|Identifier of a service instance. -It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id|string -|**name** + -__optional__|Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.|string -|**relatedParty** + -__optional__||< <<_relatedparty,RelatedParty>> > array -|**serviceCharacteristic** + -__optional__||< <<_servicecharacteristic,ServiceCharacteristic>> > array -|**serviceRelationship** + -__optional__||< <<_servicerelationship,ServiceRelationship>> > array -|**serviceSpecification** + -__optional__||<<_servicespecificationref,ServiceSpecificationRef>> -|**serviceState** + -__optional__|The lifecycle state of the service requested; -Not managed in Beijing release.|string -|=== - - -[[_servicecharacteristic]] -=== ServiceCharacteristic -ServiceCharacteristic - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**name** + -__required__|Name of characteristic|string -|**value** + -__optional__||<<_value,Value>> -|**valueType** + -__optional__||string -|=== - - -[[_serviceorder]] -=== ServiceOrder -A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__||string -|**@schemaLocation** + -__optional__||string -|**@type** + -__optional__||string -|**category** + -__optional__|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)|string -|**completionDateTime** + -__optional__|Date when the order was completed|string (date-time) -|**description** + -__optional__|A free-text description of the service order|string -|**expectedCompletionDate** + -__optional__||string (date-time) -|**externalId** + -__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string -|**href** + -__optional__|Hyperlink to access the order|string -|**id** + -__required__|ID created on repository side|string -|**orderDate** + -__optional__||string (date-time) -|**orderItem** + -__optional__||< <<_serviceorderitem,ServiceOrderItem>> > array -|**orderMessage** + -__optional__||< <<_ordermessage,OrderMessage>> > array -|**orderRelationship** + -__optional__||< <<_orderrelationship,OrderRelationship>> > array -|**priority** + -__optional__|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string -|**relatedParty** + -__optional__||< <<_relatedparty,RelatedParty>> > array -|**requestedCompletionDate** + -__optional__|Requested delivery date from the requestor perspective|string (date-time) -|**requestedStartDate** + -__optional__|Order start date wished by the requestor|string (date-time) -|**startDate** + -__optional__|Date when the order was started for processing|string (date-time) -|**state** + -__optional__||<<_statetype,StateType>> -|=== - - -[[_serviceordercreationnotification]] -=== ServiceOrderCreationNotification -Notification structure for a service order creation notification - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**event** + -__required__||<<_serviceordersummary,ServiceOrderSummary>> -|**eventDate** + -__required__||string (date-time) -|**eventId** + -__required__||string -|**eventType** + -__required__|**Default** : `"ServiceOrderCreationNotification"`|string -|=== - - -[[_serviceorderitem]] -=== ServiceOrderItem -An identified part of the order. A service order is decomposed into one or more order items. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__|not used in Beijing relase|string -|**@schemaLocation** + -__optional__|not used in Beijing relase|string -|**@type** + -__optional__|Used to extend the order item. -not used in Beijing relase|string -|**action** + -__optional__||<<_actiontype,ActionType>> -|**id** + -__required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string -|**orderItemMessage** + -__optional__||< <<_ordermessage,OrderMessage>> > array -|**orderItemRelationship** + -__optional__||< <<_orderitemrelationship,OrderItemRelationship>> > array -|**percentProgress** + -__optional__|Progress of the delivery in percentage.|string -|**service** + -__required__||<<_service,Service>> -|**state** + -__optional__||<<_statetype,StateType>> -|=== - - -[[_serviceorderitemstatechangenotification]] -=== ServiceOrderItemStateChangeNotification - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**event** + -__required__||<<_serviceordersummarywithitem,ServiceOrderSummaryWithItem>> -|**eventDate** + -__required__||string (date-time) -|**eventId** + -__required__||string -|**eventType** + -__required__|**Default** : `"ServiceOrderStateChangeNotification"`|string -|=== - - -[[_serviceorderitemsummary]] -=== ServiceOrderItemSummary -Service Order item summary to be used for notification - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**action** + -__optional__||<<_actiontype,ActionType>> -|**id** + -__required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string -|**service** + -__required__||<<_service,Service>> -|**state** + -__optional__||<<_statetype,StateType>> -|=== - - -[[_serviceorderstatechangenotification]] -=== ServiceOrderStateChangeNotification -Service order state change notification description - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**event** + -__required__||<<_serviceordersummary,ServiceOrderSummary>> -|**eventDate** + -__required__||string (date-time) -|**eventId** + -__required__||string -|**eventType** + -__required__|**Default** : `"ServiceOrderStateChangeNotification"`|string -|=== - - -[[_serviceordersummary]] -=== ServiceOrderSummary -This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**completionDateTime** + -__optional__|Date when the order was completed|string (date-time) -|**externalId** + -__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string -|**href** + -__optional__|Hyperlink to access the order|string -|**id** + -__required__|ID created on repository side|string -|**orderDate** + -__optional__||string (date-time) -|**state** + -__optional__||<<_statetype,StateType>> -|=== - - -[[_serviceordersummarywithitem]] -=== ServiceOrderSummaryWithItem -Service order item summary with item description - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**completionDateTime** + -__optional__|Date when the order was completed|string (date-time) -|**externalId** + -__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string -|**href** + -__optional__|Hyperlink to access the order|string -|**id** + -__required__|ID created on repository side|string -|**orderDate** + -__optional__||string (date-time) -|**orderItem** + -__optional__||< <<_serviceorderitemsummary,ServiceOrderItemSummary>> > array -|**state** + -__optional__||<<_statetype,StateType>> -|=== - - -[[_serviceref]] -=== ServiceRef -Service references - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**href** + -__optional__|Reference of the service|string -|**id** + -__required__|Unique identifier of the service|string -|=== - - -[[_servicerelationship]] -=== ServiceRelationship -Linked Services to the one instantiate -nbi component used this relationship to sort request to ONAP. - - -[options="header", cols=".^3,.^4"] -|=== -|Name|Schema -|**service** + -__required__|<<_service,Service>> -|**type** + -__required__|<<_relationshiptype,RelationshipType>> -|=== - - -[[_servicespecificationref]] -=== ServiceSpecificationRef -The service specification (these attributes are fetched from the catalogue). - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__|Not used in Beijing release|string -|**@schemaLocation** + -__optional__|Not used in Beijing release|string -|**@type** + -__optional__|Not used in Beijing release|string -|**href** + -__optional__|Reference of the service specification -Not used in Beijing release.|string -|**id** + -__required__|Unique identifier of the service specification -This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.|string -|**name** + -__optional__|Name of the service specification -Not used in Beijing release|string -|**targetServiceSchema** + -__optional__||<<_targetserviceschema,TargetServiceSchema>> -|**version** + -__optional__|Version of the service Specification -Not used in Beijing release|string -|=== - - -[[_severitymessage]] -=== SeverityMessage -__Type__ : enum (information, error) - - -[[_statetype]] -=== StateType -List of possible state for the order and the orderItem. - -__Type__ : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial) - - -[[_targetserviceschema]] -=== TargetServiceSchema -Target to the schema describing the service spec resource - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__required__|This field provided a link to the schema describing this REST resource.|string -|**@type** + -__required__|Indicates the (class) type of resource.|string -|=== - - -[[_value]] -=== Value -Value is a descriptive structure for service characteristic; -For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|This field provided a link to the schema describing this REST resource. -Not used in Beijing Release|string -|**@type** + -__optional__|Indicates the (class) type of resource. -Not used in Beijing Release|string -|**serviceCharacteristicValue** + -__optional__|Value of the characteristic. -This attribute must be used in Beijing Release to provide characteristic value.|string -|=== - diff --git a/docs/offeredapis/serviceOrder/documentation.html b/docs/offeredapis/serviceOrder/documentation.html deleted file mode 100644 index cab4964..0000000 --- a/docs/offeredapis/serviceOrder/documentation.html +++ /dev/null @@ -1,3503 +0,0 @@ - - - - - - - -API ServiceOrder - - - - - -
-
-

Overview

-
-
-

Api URL

-
-

Swagger UI

-
-
-

plant UML UI

-
-
-

serviceOrder API designed for ONAP. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0); -Only operations GET (by id and list) and POST are available.

-
-
-
-

Version information

-
-

Version : 3.0.0_inProgress

-
-
-
-

URI scheme

-
-

Host : serverRoot
-BasePath : /nbi/api/v3
-Schemes : HTTPS

-
-
-
-

Tags

-
-
    -
  • -

    Hub

    -
    • -
  • -

    Notification

    -
    • -
  • -

    ServiceOrder : A 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.

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-

Resources

-
-
-

Hub

-
-

Create Hub

-
-
-
POST /hub
-
-
-
-
Description
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Body

Hub
-required

CreateHub

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

201

Success
-Headers :
-location (string)

file

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Consumes
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Retrieve a lits of hub

-
-
-
GET /hub
-
-
-
-
Description
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - - - - - - -
TypeNameSchema

Query

eventType
-optional

enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

Query

id
-optional

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

< Hub > array

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Retrieve an HUB by id

-
-
-
GET /hub/{hubId}
-
-
-
-
Description
-
-

Retrieve an HUB by id

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Path

hubId
-required

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

Hub

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

delete hub

-
-
-
DELETE /hub/{hubId}
-
-
-
-
Description
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Path

hubId
-required

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

204

Success

No Content

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
-
-

Notification

-
-

Service order creation notification

-
-
-
POST /notification/serviceOrderCreationNotification
-
-
-
-
Description
-
-

Service order creation notification

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Body

serviceOrderCreationNotification
-required

ServiceOrderCreationNotification

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

204

Success

No Content

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Consumes
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

ServiceOrder Item State Change Notification description

-
-
-
POST /notification/serviceOrderItemStateChangeNotification
-
-
-
-
Description
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Body

serviceOrderItemStateChangeNotification
-required

ServiceOrderItemStateChangeNotification

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

204

Success

No Content

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Consumes
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Service order state change notification description

-
-
-
POST /notification/serviceOrderStateChangeNotification
-
-
-
-
Description
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Body

serviceOrderstateChangeNotification
-required

ServiceOrderStateChangeNotification

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

204

Success

No Content

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Consumes
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-

ServiceOrder

-
-

A 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.

-
-
-

Create a service order

-
-
-
POST /serviceOrder
-
-
-
-
Description
-
-

This operation creates a service order entity. -The 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. -POST 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.

-
-
-

In 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.

-
-
-

In 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. -Depending 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.

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
    -
  • -

    100: OrderItem with 'add' action but serviceSpecification id missing

    -
    • -
  • -

    101: OrderItem with 'change'/'noChange'/'remove' but service id missing

    -
    • -
  • -

    102: OrderItem with 'add' action - serviceSpecification id provided but not existing

    -
    • -
  • -

    103: OrderItem with 'add' action but service id already existing in the inventory

    -
    • -
  • -

    104: A customer for existing service(s) is provided but he did not exist

    -
    • -
  • -

    105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

    -
    • -
  • -

    106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided

    -
    • -
-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - -
TypeNameSchema

Body

serviceOrder
-required

CreateServiceOrder

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

201

Success

ServiceOrder

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

-

Specific encapsulated business errors for current operation

-

* 100: OrderItem with 'add' action but serviceSpecification id missing

-

* 101: OrderItem with 'change'/'noChange'/'remove' but service id missing

-

* 102: OrderItem with 'add' action - serviceSpecification id provided but not existing

-

* 103: OrderItem with 'add' action but service id already existing in the inventory

-

* 104: A customer for existing service(s) is provided but he did not exist

-

* 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

-

* 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Consumes
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

List service orders

-
-
-
GET /serviceOrder
-
-
-
-
Description
-
-

Retrieve and list service order entities according to given criteria. -Only a predefined set of attribute is proposed. -Attribute selection could be described in the fields attribute.

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionSchema

Query

description
-optional

string

Query

externalId
-optional

string

Query

fields
-optional

this attribute could be used to filter retrieved attribute(s) and/or sort SO.

string

Query

limit
-optional

The maximum number of elements to retrieve (it can be greater than the actual available number of items).

integer (int32)

Query

offset
-optional

The index of the first element to retrieve. Zero is the first element of the collection.

integer (int32)

Query

orderDate.gt
-optional

order date greather than

string

Query

orderDate.lt
-optional

order date lower than

string

Query

state
-optional

state of the order(s) to be retrieved

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success
-Headers :
-X-Total-Count (integer (int32))
-X-Result-Count (integer (int32))

< ServiceOrder > array

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Retrieve a service order

-
-
-
GET /serviceOrder/{id}
-
-
-
-
Description
-
-

This operation retrieves a service order entity. -Attribute selection is enabled for all first level attributes.

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ------ - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionSchema

Path

id
-required

string

Query

fields
-optional

Attribute selection

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

ServiceOrder

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-
-
-

Definitions

-
-
-

ActionType

-
-

Action type to be describer on the order item. -modify is not managed in Beijing release

-
-
-

Type : enum (add, modify, delete, noChange)

-
-
-
-

CreateHub

-
-

This structure is used as a request for POST Hub operation

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

callback
-required

Address where notification must be send

string

query
-required

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

string

-
-
-

CreateServiceOrder

-
-

This structure is used in the operation POST for a serviceOrder request. -Attribute description is not accurate and should be find in the serviceOrder class.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

string

@schemaLocation
-optional

string

@type
-optional

string

category
-optional

Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)

string

description
-optional

A free-text description of the service order

string

externalId
-optional

ID given by the consumer and only understandable by him (to facilitate his searches)

string

orderItem
-optional

< CreateServiceOrderItem > array

orderRelationship
-optional

< OrderRelationship > array

priority
-optional

A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)

string

relatedParty
-optional

< RelatedParty > array

requestedCompletionDate
-optional

Requested delivery date from the requestor perspective

string (date-time)

requestedStartDate
-optional

Order start date wished by the requestor

string (date-time)

-
-
-

CreateServiceOrderItem

-
-

This structure is used in the operation POST for a serviceOrder request to describe an item. -Attribute description is not accurate and should be find in the serviceOrderItem class.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

Indicates the base type of the resource.

string

@schemaLocation
-optional

A link to the schema describing this REST resource

string

@type
-optional

Indicates the type of resource.

string

action
-optional

ActionType

id
-required

Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

string

orderItemRelationship
-optional

< OrderItemRelationship > array

service
-required

Service

-
-
-

ErrorRepresentation

-
-

Representation of an error.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

it provides a link to the schema describing a REST resource

string

@type
-optional

The class type of a REST resource

string

code
-required

Application related code (as defined in the API or from a common list)

integer (int32)

message
-optional

Text that provide more details and corrective actions related to the error. This can be shown to a client user

string

reason
-required

Text that explains the reason for error. This can be shown to a client user.

string

referenceError
-optional

url pointing to documentation describing the error

string

status
-optional

http error code extension like 400-2

string

-
-
-

EventType

-
-

Type : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

-
-
-
-

Hub

-
-

An HUB resource is used by client side to subscribe to notification. -Not managed in the Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

callback
-required

Address where notification must be send

string

id
-optional

Hub Id

string

query
-required

string

-
-
-

Notification

-
-

Used to describe notification for this API

-
-
-

Type : object

-
-
-
-

OrderItemRelationship

-
-

Linked order item to the one containing this attribute. -nbi component used this relationship to sort request to ONAP.

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-required

Unique identifier of an order item

string

type
-required

RelationshipType

-
-
-

OrderMessage

-
-

An optional array of messages associated with the Order

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

code
-optional

A code associated to this message

string

correctionRequired
-required

Indicator that an action is required to allow service order fullfilment to follow up

boolean

field
-optional

Service Order attribute related to this error message

string

messageInformation
-optional

Message related to this order

string

severity
-required

SeverityMessage

-
-
-

OrderRelationship

-
-

Linked order to the one containing this attribute. -This relationship is not used to sort ONAP request.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

Type of the referred order.

string

href
-optional

A hyperlink to the related order

string

id
-required

The id of the related order

string

type
-optional

The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)

string

-
-
-

RelatedParty

-
-

A related party defines party which are involved in this order and the role they are playing. -for Beijing release: -With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information: -o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not. -o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

string

href
-optional

An hyperlink to the party - not used in Beijnig release

string

id
-required

Unique identifier of a related party

string

name
-optional

Name of the related party

string

role
-required

The role of the related party (e.g. Owner, requester, fullfiller etc). -ONLY 'ONAPcustomer' is considered

string

-
-
-

RelationshipType

-
-

Relationship type; -Only reliesOn is managed in Beijing release.

-
-
-

Type : enum (reliesOn)

-
-
-
-

Service

-
-

Service (to be added, modified, deleted) description

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

The URL to get the resource schema. -Not managed in Beijing Release

string

@type
-optional

To define the service type -Not managed in Beijing Release

string

href
-optional

Reference to the Service (useful for delete or modify command). -Not managed in Beijing release.

string

id
-required

Identifier of a service instance. -It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id

string

name
-optional

Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.

string

relatedParty
-optional

< RelatedParty > array

serviceCharacteristic
-optional

< ServiceCharacteristic > array

serviceRelationship
-optional

< ServiceRelationship > array

serviceSpecification
-optional

ServiceSpecificationRef

serviceState
-optional

The lifecycle state of the service requested; -Not managed in Beijing release.

string

-
-
-

ServiceCharacteristic

-
-

ServiceCharacteristic

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

name
-required

Name of characteristic

string

value
-optional

Value

valueType
-optional

string

-
-
-

ServiceOrder

-
-

A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

string

@schemaLocation
-optional

string

@type
-optional

string

category
-optional

Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)

string

completionDateTime
-optional

Date when the order was completed

string (date-time)

description
-optional

A free-text description of the service order

string

expectedCompletionDate
-optional

string (date-time)

externalId
-optional

ID given by the consumer and only understandable by him (to facilitate his searches)

string

href
-optional

Hyperlink to access the order

string

id
-required

ID created on repository side

string

orderDate
-optional

string (date-time)

orderItem
-optional

< ServiceOrderItem > array

orderMessage
-optional

< OrderMessage > array

orderRelationship
-optional

< OrderRelationship > array

priority
-optional

A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)

string

relatedParty
-optional

< RelatedParty > array

requestedCompletionDate
-optional

Requested delivery date from the requestor perspective

string (date-time)

requestedStartDate
-optional

Order start date wished by the requestor

string (date-time)

startDate
-optional

Date when the order was started for processing

string (date-time)

state
-optional

StateType

-
-
-

ServiceOrderCreationNotification

-
-

Notification structure for a service order creation notification

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

event
-required

ServiceOrderSummary

eventDate
-required

string (date-time)

eventId
-required

string

eventType
-required

Default : "ServiceOrderCreationNotification"

string

-
-
-

ServiceOrderItem

-
-

An identified part of the order. A service order is decomposed into one or more order items.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

not used in Beijing relase

string

@schemaLocation
-optional

not used in Beijing relase

string

@type
-optional

Used to extend the order item. -not used in Beijing relase

string

action
-optional

ActionType

id
-required

Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

string

orderItemMessage
-optional

< OrderMessage > array

orderItemRelationship
-optional

< OrderItemRelationship > array

percentProgress
-optional

Progress of the delivery in percentage.

string

service
-required

Service

state
-optional

StateType

-
-
-

ServiceOrderItemStateChangeNotification

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

event
-required

ServiceOrderSummaryWithItem

eventDate
-required

string (date-time)

eventId
-required

string

eventType
-required

Default : "ServiceOrderStateChangeNotification"

string

-
-
-

ServiceOrderItemSummary

-
-

Service Order item summary to be used for notification

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

action
-optional

ActionType

id
-required

Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

string

service
-required

Service

state
-optional

StateType

-
-
-

ServiceOrderStateChangeNotification

-
-

Service order state change notification description

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

event
-required

ServiceOrderSummary

eventDate
-required

string (date-time)

eventId
-required

string

eventType
-required

Default : "ServiceOrderStateChangeNotification"

string

-
-
-

ServiceOrderSummary

-
-

This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

completionDateTime
-optional

Date when the order was completed

string (date-time)

externalId
-optional

ID given by the consumer and only understandable by him (to facilitate his searches)

string

href
-optional

Hyperlink to access the order

string

id
-required

ID created on repository side

string

orderDate
-optional

string (date-time)

state
-optional

StateType

-
-
-

ServiceOrderSummaryWithItem

-
-

Service order item summary with item description

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

completionDateTime
-optional

Date when the order was completed

string (date-time)

externalId
-optional

ID given by the consumer and only understandable by him (to facilitate his searches)

string

href
-optional

Hyperlink to access the order

string

id
-required

ID created on repository side

string

orderDate
-optional

string (date-time)

orderItem
-optional

< ServiceOrderItemSummary > array

state
-optional

StateType

-
-
-

ServiceRef

-
-

Service references

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

href
-optional

Reference of the service

string

id
-required

Unique identifier of the service

string

-
-
-

ServiceRelationship

-
-

Linked Services to the one instantiate -nbi component used this relationship to sort request to ONAP.

-
- ---- - - - - - - - - - - - - - - - - -
NameSchema

service
-required

Service

type
-required

RelationshipType

-
-
-

ServiceSpecificationRef

-
-

The service specification (these attributes are fetched from the catalogue).

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

Not used in Beijing release

string

@schemaLocation
-optional

Not used in Beijing release

string

@type
-optional

Not used in Beijing release

string

href
-optional

Reference of the service specification -Not used in Beijing release.

string

id
-required

Unique identifier of the service specification -This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.

string

name
-optional

Name of the service specification -Not used in Beijing release

string

targetServiceSchema
-optional

TargetServiceSchema

version
-optional

Version of the service Specification -Not used in Beijing release

string

-
-
-

SeverityMessage

-
-

Type : enum (information, error)

-
-
-
-

StateType

-
-

List of possible state for the order and the orderItem.

-
-
-

Type : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial)

-
-
-
-

TargetServiceSchema

-
-

Target to the schema describing the service spec resource

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-required

This field provided a link to the schema describing this REST resource.

string

@type
-required

Indicates the (class) type of resource.

string

-
-
-

Value

-
-

Value is a descriptive structure for service characteristic; -For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

This field provided a link to the schema describing this REST resource. -Not used in Beijing Release

string

@type
-optional

Indicates the (class) type of resource. -Not used in Beijing Release

string

serviceCharacteristicValue
-optional

Value of the characteristic. -This attribute must be used in Beijing Release to provide characteristic value.

string

-
-
-
-
- - - \ No newline at end of file diff --git a/docs/offeredapis/serviceOrder/markDown.md b/docs/offeredapis/serviceOrder/markDown.md deleted file mode 100644 index 0c11b20..0000000 --- a/docs/offeredapis/serviceOrder/markDown.md +++ /dev/null @@ -1,890 +0,0 @@ -# API ServiceOrder - - - -## Overview - -### Api URL - -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json) - - -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0) - -serviceOrder API designed for ONAP. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0); -Only operations GET (by id and list) and POST are available. - - -### Version information -*Version* : 3.0.0_inProgress - - -### URI scheme -*Host* : serverRoot -*BasePath* : /nbi/api/v3 -*Schemes* : HTTPS - - -### Tags - -* Hub -* Notification -* ServiceOrder : A 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. - - -### Produces - -* `application/json;charset=utf-8` - - - -## Resources - - -### Hub - - -#### Create Hub -``` -POST /hub -``` - - -##### Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Body**|**Hub**
*required*|[CreateHub](#createhub)| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**201**|Success
**Headers** :
`location` (string)|file| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Consumes - -* `application/json;charset=utf-8` - - - -#### Retrieve a lits of hub -``` -GET /hub -``` - - -##### Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Query**|**eventType**
*optional*|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)| -|**Query**|**id**
*optional*|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|< [Hub](#hub) > array| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -#### Retrieve an HUB by id -``` -GET /hub/{hubId} -``` - - -##### Description -Retrieve an HUB by id - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Path**|**hubId**
*required*|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|[Hub](#hub)| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -#### delete hub -``` -DELETE /hub/{hubId} -``` - - -##### Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Path**|**hubId**
*required*|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**204**|Success|No Content| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - - -### Notification - - -#### Service order creation notification -``` -POST /notification/serviceOrderCreationNotification -``` - - -##### Description -Service order creation notification - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Body**|**serviceOrderCreationNotification**
*required*|[ServiceOrderCreationNotification](#serviceordercreationnotification)| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**204**|Success|No Content| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Consumes - -* `application/json;charset=utf-8` - - - -#### ServiceOrder Item State Change Notification description -``` -POST /notification/serviceOrderItemStateChangeNotification -``` - - -##### Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Body**|**serviceOrderItemStateChangeNotification**
*required*|[ServiceOrderItemStateChangeNotification](#serviceorderitemstatechangenotification)| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**204**|Success|No Content| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Consumes - -* `application/json;charset=utf-8` - - - -#### Service order state change notification description -``` -POST /notification/serviceOrderStateChangeNotification -``` - - -##### Description -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Body**|**serviceOrderstateChangeNotification**
*required*|[ServiceOrderStateChangeNotification](#serviceorderstatechangenotification)| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**204**|Success|No Content| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Consumes - -* `application/json;charset=utf-8` - - - -### ServiceOrder -A 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. - - - -#### Create a service order -``` -POST /serviceOrder -``` - - -##### Description -This operation creates a service order entity. -The 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. -POST 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. - -In 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. - -In 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. -Depending 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. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - - 100: OrderItem with 'add' action but serviceSpecification id missing - - - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing - - - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing - - - 103: OrderItem with 'add' action but service id already existing in the inventory - - - 104: A customer for existing service(s) is provided but he did not exist - - - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory - - - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided - - -##### Parameters - -|Type|Name|Schema| -|---|---|---| -|**Body**|**serviceOrder**
*required*|[CreateServiceOrder](#createserviceorder)| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**201**|Success|[ServiceOrder](#serviceorder)| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error

Specific encapsulated business errors for current operation

- 100: OrderItem with 'add' action but serviceSpecification id missing

- 101: OrderItem with 'change'/'noChange'/'remove' but service id missing

- 102: OrderItem with 'add' action - serviceSpecification id provided but not existing

- 103: OrderItem with 'add' action but service id already existing in the inventory

- 104: A customer for existing service(s) is provided but he did not exist

- 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

- 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Consumes - -* `application/json;charset=utf-8` - - -##### Produces - -* `application/json;charset=utf-8` - - - -#### List service orders -``` -GET /serviceOrder -``` - - -##### Description -Retrieve and list service order entities according to given criteria. -Only a predefined set of attribute is proposed. -Attribute selection could be described in the fields attribute. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Description|Schema| -|---|---|---|---| -|**Query**|**description**
*optional*||string| -|**Query**|**externalId**
*optional*||string| -|**Query**|**fields**
*optional*|this attribute could be used to filter retrieved attribute(s) and/or sort SO.|string| -|**Query**|**limit**
*optional*|The maximum number of elements to retrieve (it can be greater than the actual available number of items).|integer (int32)| -|**Query**|**offset**
*optional*|The index of the first element to retrieve. Zero is the first element of the collection.|integer (int32)| -|**Query**|**orderDate.gt**
*optional*|order date greather than|string| -|**Query**|**orderDate.lt**
*optional*|order date lower than|string| -|**Query**|**state**
*optional*|state of the order(s) to be retrieved|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success
**Headers** :
`X-Total-Count` (integer (int32))
`X-Result-Count` (integer (int32))|< [ServiceOrder](#serviceorder) > array| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -#### Retrieve a service order -``` -GET /serviceOrder/{id} -``` - - -##### Description -This operation retrieves a service order entity. -Attribute selection is enabled for all first level attributes. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Description|Schema| -|---|---|---|---| -|**Path**|**id**
*required*||string| -|**Query**|**fields**
*optional*|Attribute selection|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|[ServiceOrder](#serviceorder)| -|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found

List of supported error codes:
- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity

Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - - -## Definitions - - -### ActionType -Action type to be describer on the order item. -modify is not managed in Beijing release - -*Type* : enum (add, modify, delete, noChange) - - - -### CreateHub -This structure is used as a request for POST Hub operation - - -|Name|Description|Schema| -|---|---|---| -|**callback**
*required*|Address where notification must be send|string| -|**query**
*required*|The query must have an eventType=notificationName information.
Optionally a ? could be added to reduce hub.
query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string| - - - -### CreateServiceOrder -This structure is used in the operation POST for a serviceOrder request. -Attribute description is not accurate and should be find in the serviceOrder class. - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*||string| -|**@schemaLocation**
*optional*||string| -|**@type**
*optional*||string| -|**category**
*optional*|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)|string| -|**description**
*optional*|A free-text description of the service order|string| -|**externalId**
*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| -|**orderItem**
*optional*||< [CreateServiceOrderItem](#createserviceorderitem) > array| -|**orderRelationship**
*optional*||< [OrderRelationship](#orderrelationship) > array| -|**priority**
*optional*|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string| -|**relatedParty**
*optional*||< [RelatedParty](#relatedparty) > array| -|**requestedCompletionDate**
*optional*|Requested delivery date from the requestor perspective|string (date-time)| -|**requestedStartDate**
*optional*|Order start date wished by the requestor|string (date-time)| - - - -### CreateServiceOrderItem -This structure is used in the operation POST for a serviceOrder request to describe an item. -Attribute description is not accurate and should be find in the serviceOrderItem class. - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*|Indicates the base type of the resource.|string| -|**@schemaLocation**
*optional*|A link to the schema describing this REST resource|string| -|**@type**
*optional*|Indicates the type of resource.|string| -|**action**
*optional*||[ActionType](#actiontype)| -|**id**
*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| -|**orderItemRelationship**
*optional*||< [OrderItemRelationship](#orderitemrelationship) > array| -|**service**
*required*||[Service](#service)| - - - -### ErrorRepresentation -Representation of an error. - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|it provides a link to the schema describing a REST resource|string| -|**@type**
*optional*|The class type of a REST resource|string| -|**code**
*required*|Application related code (as defined in the API or from a common list)|integer (int32)| -|**message**
*optional*|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string| -|**reason**
*required*|Text that explains the reason for error. This can be shown to a client user.|string| -|**referenceError**
*optional*|url pointing to documentation describing the error|string| -|**status**
*optional*|http error code extension like 400-2|string| - - - -### EventType -*Type* : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) - - - -### Hub -An HUB resource is used by client side to subscribe to notification. -Not managed in the Beijing release. - - -|Name|Description|Schema| -|---|---|---| -|**callback**
*required*|Address where notification must be send|string| -|**id**
*optional*|Hub Id|string| -|**query**
*required*||string| - - - -### Notification -Used to describe notification for this API - -*Type* : object - - - -### OrderItemRelationship -Linked order item to the one containing this attribute. -nbi component used this relationship to sort request to ONAP. - - -|Name|Description|Schema| -|---|---|---| -|**id**
*required*|Unique identifier of an order item|string| -|**type**
*required*||[RelationshipType](#relationshiptype)| - - - -### OrderMessage -An optional array of messages associated with the Order - - -|Name|Description|Schema| -|---|---|---| -|**code**
*optional*|A code associated to this message|string| -|**correctionRequired**
*required*|Indicator that an action is required to allow service order fullfilment to follow up|boolean| -|**field**
*optional*|Service Order attribute related to this error message|string| -|**messageInformation**
*optional*|Message related to this order|string| -|**severity**
*required*||[SeverityMessage](#severitymessage)| - - - -### OrderRelationship -Linked order to the one containing this attribute. -This relationship is not used to sort ONAP request. - - -|Name|Description|Schema| -|---|---|---| -|**@referredType**
*optional*|Type of the referred order.|string| -|**href**
*optional*|A hyperlink to the related order|string| -|**id**
*required*|The id of the related order|string| -|**type**
*optional*|The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)|string| - - - -### RelatedParty -A related party defines party which are involved in this order and the role they are playing. -for Beijing release: -With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information: -o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not. -o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists. - - -|Name|Description|Schema| -|---|---|---| -|**@referredType**
*optional*||string| -|**href**
*optional*|An hyperlink to the party - not used in Beijnig release|string| -|**id**
*required*|Unique identifier of a related party|string| -|**name**
*optional*|Name of the related party|string| -|**role**
*required*|The role of the related party (e.g. Owner, requester, fullfiller etc).
ONLY 'ONAPcustomer' is considered|string| - - - -### RelationshipType -Relationship type; -Only reliesOn is managed in Beijing release. - -*Type* : enum (reliesOn) - - - -### Service -Service (to be added, modified, deleted) description - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|The URL to get the resource schema.
Not managed in Beijing Release|string| -|**@type**
*optional*|To define the service type
Not managed in Beijing Release|string| -|**href**
*optional*|Reference to the Service (useful for delete or modify command).
Not managed in Beijing release.|string| -|**id**
*required*|Identifier of a service instance.
It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id|string| -|**name**
*optional*|Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.|string| -|**relatedParty**
*optional*||< [RelatedParty](#relatedparty) > array| -|**serviceCharacteristic**
*optional*||< [ServiceCharacteristic](#servicecharacteristic) > array| -|**serviceRelationship**
*optional*||< [ServiceRelationship](#servicerelationship) > array| -|**serviceSpecification**
*optional*||[ServiceSpecificationRef](#servicespecificationref)| -|**serviceState**
*optional*|The lifecycle state of the service requested;
Not managed in Beijing release.|string| - - - -### ServiceCharacteristic -ServiceCharacteristic - - -|Name|Description|Schema| -|---|---|---| -|**name**
*required*|Name of characteristic|string| -|**value**
*optional*||[Value](#value)| -|**valueType**
*optional*||string| - - - -### ServiceOrder -A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*||string| -|**@schemaLocation**
*optional*||string| -|**@type**
*optional*||string| -|**category**
*optional*|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)|string| -|**completionDateTime**
*optional*|Date when the order was completed|string (date-time)| -|**description**
*optional*|A free-text description of the service order|string| -|**expectedCompletionDate**
*optional*||string (date-time)| -|**externalId**
*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| -|**href**
*optional*|Hyperlink to access the order|string| -|**id**
*required*|ID created on repository side|string| -|**orderDate**
*optional*||string (date-time)| -|**orderItem**
*optional*||< [ServiceOrderItem](#serviceorderitem) > array| -|**orderMessage**
*optional*||< [OrderMessage](#ordermessage) > array| -|**orderRelationship**
*optional*||< [OrderRelationship](#orderrelationship) > array| -|**priority**
*optional*|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string| -|**relatedParty**
*optional*||< [RelatedParty](#relatedparty) > array| -|**requestedCompletionDate**
*optional*|Requested delivery date from the requestor perspective|string (date-time)| -|**requestedStartDate**
*optional*|Order start date wished by the requestor|string (date-time)| -|**startDate**
*optional*|Date when the order was started for processing|string (date-time)| -|**state**
*optional*||[StateType](#statetype)| - - - -### ServiceOrderCreationNotification -Notification structure for a service order creation notification - - -|Name|Description|Schema| -|---|---|---| -|**event**
*required*||[ServiceOrderSummary](#serviceordersummary)| -|**eventDate**
*required*||string (date-time)| -|**eventId**
*required*||string| -|**eventType**
*required*|**Default** : `"ServiceOrderCreationNotification"`|string| - - - -### ServiceOrderItem -An identified part of the order. A service order is decomposed into one or more order items. - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*|not used in Beijing relase|string| -|**@schemaLocation**
*optional*|not used in Beijing relase|string| -|**@type**
*optional*|Used to extend the order item.
not used in Beijing relase|string| -|**action**
*optional*||[ActionType](#actiontype)| -|**id**
*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| -|**orderItemMessage**
*optional*||< [OrderMessage](#ordermessage) > array| -|**orderItemRelationship**
*optional*||< [OrderItemRelationship](#orderitemrelationship) > array| -|**percentProgress**
*optional*|Progress of the delivery in percentage.|string| -|**service**
*required*||[Service](#service)| -|**state**
*optional*||[StateType](#statetype)| - - - -### ServiceOrderItemStateChangeNotification - -|Name|Description|Schema| -|---|---|---| -|**event**
*required*||[ServiceOrderSummaryWithItem](#serviceordersummarywithitem)| -|**eventDate**
*required*||string (date-time)| -|**eventId**
*required*||string| -|**eventType**
*required*|**Default** : `"ServiceOrderStateChangeNotification"`|string| - - - -### ServiceOrderItemSummary -Service Order item summary to be used for notification - - -|Name|Description|Schema| -|---|---|---| -|**action**
*optional*||[ActionType](#actiontype)| -|**id**
*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| -|**service**
*required*||[Service](#service)| -|**state**
*optional*||[StateType](#statetype)| - - - -### ServiceOrderStateChangeNotification -Service order state change notification description - - -|Name|Description|Schema| -|---|---|---| -|**event**
*required*||[ServiceOrderSummary](#serviceordersummary)| -|**eventDate**
*required*||string (date-time)| -|**eventId**
*required*||string| -|**eventType**
*required*|**Default** : `"ServiceOrderStateChangeNotification"`|string| - - - -### ServiceOrderSummary -This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages - - -|Name|Description|Schema| -|---|---|---| -|**completionDateTime**
*optional*|Date when the order was completed|string (date-time)| -|**externalId**
*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| -|**href**
*optional*|Hyperlink to access the order|string| -|**id**
*required*|ID created on repository side|string| -|**orderDate**
*optional*||string (date-time)| -|**state**
*optional*||[StateType](#statetype)| - - - -### ServiceOrderSummaryWithItem -Service order item summary with item description - - -|Name|Description|Schema| -|---|---|---| -|**completionDateTime**
*optional*|Date when the order was completed|string (date-time)| -|**externalId**
*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| -|**href**
*optional*|Hyperlink to access the order|string| -|**id**
*required*|ID created on repository side|string| -|**orderDate**
*optional*||string (date-time)| -|**orderItem**
*optional*||< [ServiceOrderItemSummary](#serviceorderitemsummary) > array| -|**state**
*optional*||[StateType](#statetype)| - - - -### ServiceRef -Service references - - -|Name|Description|Schema| -|---|---|---| -|**href**
*optional*|Reference of the service|string| -|**id**
*required*|Unique identifier of the service|string| - - - -### ServiceRelationship -Linked Services to the one instantiate -nbi component used this relationship to sort request to ONAP. - - -|Name|Schema| -|---|---| -|**service**
*required*|[Service](#service)| -|**type**
*required*|[RelationshipType](#relationshiptype)| - - - -### ServiceSpecificationRef -The service specification (these attributes are fetched from the catalogue). - - -|Name|Description|Schema| -|---|---|---| -|**@baseType**
*optional*|Not used in Beijing release|string| -|**@schemaLocation**
*optional*|Not used in Beijing release|string| -|**@type**
*optional*|Not used in Beijing release|string| -|**href**
*optional*|Reference of the service specification
Not used in Beijing release.|string| -|**id**
*required*|Unique identifier of the service specification
This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.|string| -|**name**
*optional*|Name of the service specification
Not used in Beijing release|string| -|**targetServiceSchema**
*optional*||[TargetServiceSchema](#targetserviceschema)| -|**version**
*optional*|Version of the service Specification
Not used in Beijing release|string| - - - -### SeverityMessage -*Type* : enum (information, error) - - - -### StateType -List of possible state for the order and the orderItem. - -*Type* : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial) - - - -### TargetServiceSchema -Target to the schema describing the service spec resource - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*required*|This field provided a link to the schema describing this REST resource.|string| -|**@type**
*required*|Indicates the (class) type of resource.|string| - - - -### Value -Value is a descriptive structure for service characteristic; -For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used. - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation**
*optional*|This field provided a link to the schema describing this REST resource.
Not used in Beijing Release|string| -|**@type**
*optional*|Indicates the (class) type of resource.
Not used in Beijing Release|string| -|**serviceCharacteristicValue**
*optional*|Value of the characteristic.
This attribute must be used in Beijing Release to provide characteristic value.|string| - diff --git a/docs/offeredapis/swaggers/healthCheck_3_0_0.json b/docs/offeredapis/swaggers/healthCheck_3_0_0.json deleted file mode 100644 index 8092cb0..0000000 --- a/docs/offeredapis/swaggers/healthCheck_3_0_0.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "This is the ONAP NBI HealthCheck API", - "version" : "3.0.0", - "title" : "NBI HealthCheck API", - "contact" : { - "email" : "romain.gimbert@orange.com" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "host" : "serverRoot", - "basePath" : "/nbi/api/v3", - "schemes" : [ "http" ], - "produces": [ - "application/json;charset=utf-8" - ], - "paths" : { - "/status" : { - "get" : { - "summary" : "Displays health status for the NBI component", - "operationId" : "commitInfo", - "description" : "Displays health status for the NBI component", - "responses": { - "200": { - "description": "Service OK", - "schema": { - "$ref": "#/definitions/Status" - } - }, - "503" : { - "description" : "Service Unavailable" - } - } - } - } - }, - "definitions": { - "Status": { - "description": "NBI Status", - "type": "object", - "properties": { - "name": { - "description": "name of NBI component", - "type": "string" - }, - "status": { - "description": "status of NBI component", - "type": "string" - }, - "version": { - "description": "version of NBI component", - "type": "string" - } - } - } - } -} diff --git a/docs/offeredapis/swaggers/listener-1_0_0.json b/docs/offeredapis/swaggers/listener-1_0_0.json deleted file mode 100644 index 7aa65fb..0000000 --- a/docs/offeredapis/swaggers/listener-1_0_0.json +++ /dev/null @@ -1,210 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "Listener API has to be implemented on the client side in order to receive notification.\nNotification are received if HUB has been posted on server side.", - "version": "0.1.0", - "title": "API Listener", - "x-logo": { - "url": "/redoc/logo.png", - "backgroundColor": "#FFFFFF" - } - }, - - "host": "serverRoot", - "basePath": "/externalapi/listener/v1", - "schemes": [ - "https" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "Listener", - "description": "" - } - ], - "paths": { - "/listener": { - "post": { - "tags": [ - "Listener" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "listenerCreate", - "summary": "createEvent", - "description": "The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "event", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/Listener" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Listener" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - "EventType": { - "description": "", - - "type": "string", - "enum": [ - "ServiceOrderCreationNotification", - "ServiceOrderStateChangeNotification", - "ServiceOrderItemStateChangeNotification"] - - }, - - "ErrorRepresentation": { - "description": "", - - - "required": [ - - "code" - ], - "type": "object", - "properties": { - "code": { - "description": "", - "type": "integer", - "format": "int32" - }, - "reason": { - "description": "", - "type": "string" - }, - "message": { - "description": "", - "type": "string" - }, - "status": { - "description": "", - "type": "integer", - "format": "int32" - }, - "referenceError": { - "description": "", - "type": "string" - }, - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - } - } - - }, - - "Listener": { - "description": "An event will be triggered for each time a notification is send to a listener.", - - - "required": [ - - "eventId", - "eventDate", - "eventType", - "event" - ], - "type": "object", - "properties": { - "eventId": { - "description": "id of the event", - "type": "string" - }, - "eventDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "eventType": { - - "$ref": "#/definitions/EventType" - }, - "event": { - "description": "An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.", - "type": "object" - } - } - - } - } -} - \ No newline at end of file diff --git a/docs/offeredapis/swaggers/listener-1_0_0.yaml b/docs/offeredapis/swaggers/listener-1_0_0.yaml deleted file mode 100644 index 390abe0..0000000 --- a/docs/offeredapis/swaggers/listener-1_0_0.yaml +++ /dev/null @@ -1,142 +0,0 @@ -swagger: "2.0" -info: - description: "Listener API has to be implemented on the client side in order to\ - \ receive notification.\nNotification are received if HUB has been posted on server\ - \ side." - version: "0.1.0" - title: "API Listener" - x-logo: - url: "/redoc/logo.png" - backgroundColor: "#FFFFFF" -host: "serverRoot" -basePath: "/externalapi/listener/v1" -schemes: -- "https" -produces: -- "application/json;charset=utf-8" -tags: -- name: "Listener" - description: "" -paths: - /listener: - post: - tags: - - "Listener" - consumes: - - "application/json;charset=utf-8" - produces: - - "application/json;charset=utf-8" - operationId: "listenerCreate" - summary: "createEvent" - description: "The create event is used by the seller to trigger (POST) a notification\ - \ to the buyer. The buyer has previously subscribed to receive notification\n\ - \nSpecific business errors for current operation will be encapsulated in\n\ - \nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "event" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/Listener" - responses: - 201: - description: "Success" - schema: - $ref: "#/definitions/Listener" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - EventType: - description: "" - type: "string" - enum: - - "ServiceOrderCreationNotification" - - "ServiceOrderStateChangeNotification" - - "ServiceOrderItemStateChangeNotification" - ErrorRepresentation: - description: "" - required: - - "code" - type: "object" - properties: - code: - description: "" - type: "integer" - format: "int32" - reason: - description: "" - type: "string" - message: - description: "" - type: "string" - status: - description: "" - type: "integer" - format: "int32" - referenceError: - description: "" - type: "string" - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" - Listener: - description: "An event will be triggered for each time a notification is send\ - \ to a listener." - required: - - "eventId" - - "eventDate" - - "eventType" - - "event" - type: "object" - properties: - eventId: - description: "id of the event" - type: "string" - eventDate: - description: "" - type: "string" - format: "date-time" - eventType: - $ref: "#/definitions/EventType" - event: - description: "An event representation is the payload of information send with\ - \ the notification; it will feature event attributes + summary view of the\ - \ resource." - type: "object" diff --git a/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json deleted file mode 100644 index aedd4a5..0000000 --- a/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json +++ /dev/null @@ -1,660 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "serviceCatalog API designed for ONAP Casablanca Release.\nThis API is build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource serviceSpecification is available", - "version": "3.0.0", - "title": "API ServiceCatalog", - "x-logo": { - "url": "/redoc/logo.png", - "backgroundColor": "#FFFFFF" - } - }, - - "host": "serverRoot", - "basePath": "/nbi/api/v3", - "schemes": [ - "https" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "ServiceSpecification", - "description": "" - } - ], - "paths": { - "/serviceSpecification": { - "get": { - "tags": [ - "ServiceSpecification" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceSpecificationFind", - "summary": "List service specifications", - "description": "This operation returns service specifications from a catalog.\nOnly a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering\nFields attribute could be used to filter attributes retrieved\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "fields", - "required": false, - "in": "query", - "description": "Field selection - used to filtering the attributes to be retreived", - - "type": "string" - }, - { - "name": "category", - "required": false, - "in": "query", - "description": "Service Category (filter)", - - "type": "string" - }, - { - "name": "distributionStatus", - "required": false, - "in": "query", - "description": "Service distribution status (filter)", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceSpecification" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/serviceSpecification/{id}": { - "get": { - "tags": [ - "ServiceSpecification" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceSpecificationGet", - "summary": "Retrieve a service specification", - "description": "This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "Attribute selection", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceSpecification" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - "LifecycleStatusValues": { - "description": "Service lifecycle value from ONAP SDC", - - "type": "string", - "enum": [ - "NOT_CERTIFIED_CHECKOUT", - "NOT_CERTIFIED_CHECKIN", - "READY_FOR_CERTIFICATION", - "CERTIFICATION_IN_PROGRESS", - "CERTIFIED"] - - }, - "DistributionStatus": { - "description": "Service distribution status from ONAP.", - - "type": "string", - "enum": [ - "DISTRIBUTION_NOT_APPROVED", - "DISTRIBUTION_APPROVED", - "DISTRIBUTED", - "DISTRIBUTION_REJECTED"] - - }, - - "ErrorRepresentation": { - "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", - - - "required": [ - - "code", - "reason" - ], - "type": "object", - "properties": { - "code": { - "description": "Application related code (as defined in the API or from a common list)", - "type": "integer", - "format": "int32" - }, - "reason": { - "description": "Text that explains the reason for error. This can be shown to a client user.", - "type": "string" - }, - "message": { - "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user", - "type": "string" - }, - "status": { - "description": "http error code extension like 400-2", - "type": "string" - }, - "referenceErrror": { - "description": "url pointing to documentation describing the error", - "type": "string" - }, - "@type": { - "description": "The class type of a REST resource.", - "type": "string" - }, - "@schemaLocation": { - "description": "it provides a link to the schema describing a REST resource.", - "type": "string" - } - } - - }, - - "TimePeriod": { - "description": "A time period", - - - "type": "object", - "properties": { - "startDateTime": { - "description": "Start date and time of the period", - "type": "string", - "format": "date-time" - }, - "endDateTime": { - "description": "End date and time of the period", - "type": "string", - "format": "date-time" - } - } - - }, - - "RelatedPartyRef": { - "description": "Party linked to the service catalog.\nin nbi we retrieve information about last updater of the service in SDC", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the related party. Filled with lastUpdaterUserId", - "type": "string" - }, - "role": { - "description": "Role payed by the related party\nOnly role 'lastUpdater' is retrieved in Beijing release", - "type": "string" - }, - "name": { - "description": "Name of the related party - Filled with lastUpdatedFullName", - "type": "string" - } - } - - }, - - "ServiceSpecification": { - "description": "ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.\nthe service information are retrieved in SDC", - - - "required": [ - - "invariantUUID" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service specification. Filled with SDC Service uuid", - "type": "string" - }, - "href": { - "description": "Reference of the service specification- not mapped in Beijing", - "type": "string" - }, - "name": { - "description": "Name of the service specification- Filled with SDC Service name", - "type": "string" - }, - "description": { - "description": "A narrative that explains in detail what the service specification is - Filled with SDC Service description", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:\ninvariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory (1)\ndistributionStatus", - "type": "string", - - "default": "ONAPservice" - }, - "@schemaLocation": { - "description": "Not used for Beijing release", - "type": "string" - }, - "@baseType": { - "description": "Not used for Beijing release", - "type": "string" - }, - "invariantUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @type - invariantUUID", - "type": "string" - }, - "toscaModelURL": { - "description": "Additional attribute (not in the TMF API) - extended through @type - toscaModelURL", - "type": "string" - }, - "toscaResourceName": { - "description": "Additional attribute (not in the TMF API) - extended through @type - toscaResourceName", - "type": "string" - }, - "category": { - "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resource", - "type": "string" - }, - "subcategory": { - "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resourc", - "type": "string" - }, - "distributionStatus": { - - "$ref": "#/definitions/DistributionStatus" - }, - "version": { - "description": "Service specification version - Filled with SDC Service version", - "type": "string" - }, - "lifecycleStatus": { - - "$ref": "#/definitions/LifecycleStatusValues" - }, - "targetServiceSchema": { - - "$ref": "#/definitions/TargetServiceSchemaRef" - }, - "attachment": { - - "type": "array", - "items": { - "$ref": "#/definitions/Attachment" - } - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedPartyRef" - } - }, - "resourceSpecification": { - - "type": "array", - "items": { - "$ref": "#/definitions/ResourceSpecificationRef" - } - }, - "serviceSpecCharacteristic": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceSpecCharacteristic" - } - } - } - - }, - - "ServiceSpecCharacteristic": { - "description": "A characteristic quality or distinctive feature of a ServiceSpecification. \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.", - - - "type": "object", - "properties": { - "name": { - "description": "Name of the characteristic - Filled with parameter_name", - "type": "string" - }, - "description": { - "description": "A narrative that explains in detail what the characteristic is - Filled with parameter_description", - "type": "string" - }, - "valueType": { - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.", - "type": "string" - }, - "@schemaLocation": { - "description": "An url pointing to type description - we do not use it in nbi Beijing release", - "type": "string" - }, - "required": { - "description": "A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’", - "type": "boolean", - - "default": true - }, - "status": { - "description": "Status of the characteristic - filled with status_value", - "type": "string" - }, - "serviceSpecCharacteristicValue": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceSpecCharacteristicValue" - } - } - } - - }, - - "Attachment": { - "description": "An attachment is a file uses to describe the service.\nIn nbi we use attachment to retrieve ONAP artifacts.", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the attachment - filled with artifactUUID.", - "type": "string" - }, - "name": { - "description": "Name of the attachment - filled with artifactName", - "type": "string" - }, - "description": { - "description": "Description of the attachment - filled with artifactDescription", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\nartifactVersion\ngeneratedFromUUID", - "type": "string", - - "default": "ONAPartifact" - }, - "artifactLabel": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactLabel", - "type": "string" - }, - "artifactGroupType": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactGroupType", - "type": "string" - }, - "artifactTimeout": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactTimeout", - "type": "string" - }, - "artifactChecksum": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactChecksum", - "type": "string" - }, - "artifactVersion": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactVersion", - "type": "string" - }, - "generatedFromUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID", - "type": "string" - }, - "url": { - "description": "Uniform Resource Locator, is a web page address - filled with artifactURL", - "type": "string" - }, - "mimeType": { - "description": "Filled with artifactType", - "type": "string" - } - } - - }, - - "ServiceSpecCharacteristicValue": { - "description": "A number or text that can be assigned to a service specification characteristic.\nServiceSpecCharacteristicValue are retrieved in the service Tosca file", - - - "type": "object", - "properties": { - "valueType": { - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth\nRetrieved in the Tosca in the topology_template section in the inputs section - parameter_type. \nWe do not manage parameter_type= list or map for Beijing release", - "type": "string" - }, - "isDefault": { - "description": "Information calculated from parameter default in the Tosca file", - "type": "boolean" - }, - "value": { - "description": "A discrete value that the characteristic can take on", - "type": "string" - } - } - - }, - - "ResourceSpecificationRef": { - "description": "A list of resourceSpec identified to deliver the service.\nfor nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the resource specification - filled with resourceUUID", - "type": "string" - }, - "version": { - "description": "Version for this resource specification - filled with resourceVersion", - "type": "string" - }, - "name": { - "description": "Name of the resource specification - filled with resourceName", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:\nresourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\nmodelCustomizationId", - "type": "string", - - "default": "ONAPresource" - }, - "resourceInstanceName": { - "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName", - "type": "string" - }, - "resourceInvariantUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID", - "type": "string" - }, - "resourceType": { - "description": "Additional attribute (not in the TMF API) - extended through @type - resoucreType", - "type": "string" - }, - "modelCustomizationName": { - "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource", - "type": "string" - }, - "modelCustomizationId": { - "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource", - "type": "string" - } - } - - }, - - "TargetServiceSchemaRef": { - "description": "", - - - "required": [ - - "@type", - "@schemaLocation" - ], - "type": "object", - "properties": { - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - } - } - - } - } -} - \ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml deleted file mode 100644 index 50ae7cf..0000000 --- a/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml +++ /dev/null @@ -1,493 +0,0 @@ -swagger: "2.0" -info: - description: "serviceCatalog API designed for ONAP Casablanca Release.\nThis API is\ - \ build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource\ - \ serviceSpecification is available" - version: "3.0.0" - title: "API ServiceCatalog" - x-logo: - url: "/redoc/logo.png" - backgroundColor: "#FFFFFF" -host: "serverRoot" -basePath: "/nbi/api/v3" -schemes: -- "https" -produces: -- "application/json;charset=utf-8" -tags: -- name: "ServiceSpecification" - description: "" -paths: - /serviceSpecification: - get: - tags: - - "ServiceSpecification" - produces: - - "application/json;charset=utf-8" - operationId: "serviceSpecificationFind" - summary: "List service specifications" - description: "This operation returns service specifications from a catalog.\n\ - Only a predefined set of attribute is proposed : Based on SDC limitations,\ - \ only attributes category and distributionStatus are available for serviceSpecification\ - \ filtering\nFields attribute could be used to filter attributes retrieved\n\ - \nSpecific business errors for current operation will be encapsulated in\n\ - \nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "fields" - required: false - in: "query" - description: "Field selection - used to filtering the attributes to be retreived" - type: "string" - - name: "category" - required: false - in: "query" - description: "Service Category (filter)" - type: "string" - - name: "distributionStatus" - required: false - in: "query" - description: "Service distribution status (filter)" - type: "string" - responses: - 200: - description: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/ServiceSpecification" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /serviceSpecification/{id}: - get: - tags: - - "ServiceSpecification" - produces: - - "application/json;charset=utf-8" - operationId: "serviceSpecificationGet" - summary: "Retrieve a service specification" - description: "This operation returns a service specification by its id from\ - \ a catalog. Attribute selection is enabled using the fields attribute.\n\n\ - Specific business errors for current operation will be encapsulated in\n\n\ - HTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "id" - in: "path" - required: true - type: "string" - description: "" - - name: "fields" - required: false - in: "query" - description: "Attribute selection" - type: "string" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/ServiceSpecification" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - LifecycleStatusValues: - description: "Service lifecycle value from ONAP SDC" - type: "string" - enum: - - "NOT_CERTIFIED_CHECKOUT" - - "NOT_CERTIFIED_CHECKIN" - - "READY_FOR_CERTIFICATION" - - "CERTIFICATION_IN_PROGRESS" - - "CERTIFIED" - DistributionStatus: - description: "Service distribution status from ONAP." - type: "string" - enum: - - "DISTRIBUTION_NOT_APPROVED" - - "DISTRIBUTION_APPROVED" - - "DISTRIBUTED" - - "DISTRIBUTION_REJECTED" - ErrorRepresentation: - description: "This class is used to describe error.\nfor nbi Beijing release we\ - \ do not manage additional error for serviceCatalog" - required: - - "code" - - "reason" - type: "object" - properties: - code: - description: "Application related code (as defined in the API or from a common\ - \ list)" - type: "integer" - format: "int32" - reason: - description: "Text that explains the reason for error. This can be shown to\ - \ a client user." - type: "string" - message: - description: "Text that provide more details and corrective actions related\ - \ to the error. This can be shown to a client user" - type: "string" - status: - description: "http error code extension like 400-2" - type: "string" - referenceErrror: - description: "url pointing to documentation describing the error" - type: "string" - '@type': - description: "The class type of a REST resource." - type: "string" - '@schemaLocation': - description: "it provides a link to the schema describing a REST resource." - type: "string" - TimePeriod: - description: "A time period" - type: "object" - properties: - startDateTime: - description: "Start date and time of the period" - type: "string" - format: "date-time" - endDateTime: - description: "End date and time of the period" - type: "string" - format: "date-time" - RelatedPartyRef: - description: "Party linked to the service catalog.\nin nbi we retrieve information\ - \ about last updater of the service in SDC" - type: "object" - properties: - id: - description: "Unique identifier of the related party. Filled with lastUpdaterUserId" - type: "string" - role: - description: "Role payed by the related party\nOnly role 'lastUpdater' is\ - \ retrieved in Beijing release" - type: "string" - name: - description: "Name of the related party - Filled with lastUpdatedFullName" - type: "string" - ServiceSpecification: - description: "ServiceSpecification is a class that offers characteristics to describe\ - \ a type of service. Functionally, it acts as a template by which Services may\ - \ be instantiated. By sharing the same specification, these services would therefore\ - \ share the same set of characteristics.\nthe service information are retrieved\ - \ in SDC" - required: - - "invariantUUID" - type: "object" - properties: - id: - description: "Unique identifier of the service specification. Filled with\ - \ SDC Service uuid" - type: "string" - href: - description: "Reference of the service specification- not mapped in Beijing" - type: "string" - name: - description: "Name of the service specification- Filled with SDC Service name" - type: "string" - description: - description: "A narrative that explains in detail what the service specification\ - \ is - Filled with SDC Service description" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with 'ONAPservice'. We used this features to add following attributes:\n\ - invariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory\ - \ (1)\ndistributionStatus" - type: "string" - default: "ONAPservice" - '@schemaLocation': - description: "Not used for Beijing release" - type: "string" - '@baseType': - description: "Not used for Beijing release" - type: "string" - invariantUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - invariantUUID" - type: "string" - toscaModelURL: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - toscaModelURL" - type: "string" - toscaResourceName: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - toscaResourceName" - type: "string" - category: - description: "Additional attribute - extended through @type - category\nPlease\ - \ note that this attribute is managed in TMF - in future release we'll introduce\ - \ category resource" - type: "string" - subcategory: - description: "Additional attribute - extended through @type - category\nPlease\ - \ note that this attribute is managed in TMF - in future release we'll introduce\ - \ category resourc" - type: "string" - distributionStatus: - $ref: "#/definitions/DistributionStatus" - version: - description: "Service specification version - Filled with SDC Service version" - type: "string" - lifecycleStatus: - $ref: "#/definitions/LifecycleStatusValues" - targetServiceSchema: - $ref: "#/definitions/TargetServiceSchemaRef" - attachment: - type: "array" - items: - $ref: "#/definitions/Attachment" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedPartyRef" - resourceSpecification: - type: "array" - items: - $ref: "#/definitions/ResourceSpecificationRef" - serviceSpecCharacteristic: - type: "array" - items: - $ref: "#/definitions/ServiceSpecCharacteristic" - ServiceSpecCharacteristic: - description: "A characteristic quality or distinctive feature of a ServiceSpecification.\ - \ \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the\ - \ topology_template section in the inputs section." - type: "object" - properties: - name: - description: "Name of the characteristic - Filled with parameter_name" - type: "string" - description: - description: "A narrative that explains in detail what the characteristic\ - \ is - Filled with parameter_description" - type: "string" - valueType: - description: "A kind of value that the characteristic can take on, such as\ - \ numeric, text and so forth - Filled with parameter_type" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with: 'ONAPserviceCharacteristic'. We do not used this features in nbi\ - \ Beijing release." - type: "string" - '@schemaLocation': - description: "An url pointing to type description - we do not use it in nbi\ - \ Beijing release" - type: "string" - required: - description: "A parameter to define if the characteristic is mandatory - Filled\ - \ from parameter_required – if not fielded by default ‘true’" - type: "boolean" - default: true - status: - description: "Status of the characteristic - filled with status_value" - type: "string" - serviceSpecCharacteristicValue: - type: "array" - items: - $ref: "#/definitions/ServiceSpecCharacteristicValue" - Attachment: - description: "An attachment is a file uses to describe the service.\nIn nbi we\ - \ use attachment to retrieve ONAP artifacts." - type: "object" - properties: - id: - description: "Unique identifier of the attachment - filled with artifactUUID." - type: "string" - name: - description: "Name of the attachment - filled with artifactName" - type: "string" - description: - description: "Description of the attachment - filled with artifactDescription" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with 'ONAPartifact'. We used this features to add following attributes:\ - \ \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\n\ - artifactVersion\ngeneratedFromUUID" - type: "string" - default: "ONAPartifact" - artifactLabel: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactLabel" - type: "string" - artifactGroupType: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactGroupType" - type: "string" - artifactTimeout: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactTimeout" - type: "string" - artifactChecksum: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactChecksum" - type: "string" - artifactVersion: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactVersion" - type: "string" - generatedFromUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - generatedFromUUID" - type: "string" - url: - description: "Uniform Resource Locator, is a web page address - filled with\ - \ artifactURL" - type: "string" - mimeType: - description: "Filled with artifactType" - type: "string" - ServiceSpecCharacteristicValue: - description: "A number or text that can be assigned to a service specification\ - \ characteristic.\nServiceSpecCharacteristicValue are retrieved in the service\ - \ Tosca file" - type: "object" - properties: - valueType: - description: "A kind of value that the characteristic can take on, such as\ - \ numeric, text, and so forth\nRetrieved in the Tosca in the topology_template\ - \ section in the inputs section - parameter_type. \nWe do not manage parameter_type=\ - \ list or map for Beijing release" - type: "string" - isDefault: - description: "Information calculated from parameter default in the Tosca file" - type: "boolean" - value: - description: "A discrete value that the characteristic can take on" - type: "string" - ResourceSpecificationRef: - description: "A list of resourceSpec identified to deliver the service.\nfor nbi\ - \ we retrieve resource information available in service description (through\ - \ SDC api) bu as well information retrieved in the TOSCA file." - type: "object" - properties: - id: - description: "Unique identifier of the resource specification - filled with\ - \ resourceUUID" - type: "string" - version: - description: "Version for this resource specification - filled with resourceVersion" - type: "string" - name: - description: "Name of the resource specification - filled with resourceName" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with: 'ONAPresource'. We used this features to add following attributes:\n\ - resourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\n\ - modelCustomizationId" - type: "string" - default: "ONAPresource" - resourceInstanceName: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - resourceInstanceName" - type: "string" - resourceInvariantUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - resourceInvariantUUID" - type: "string" - resourceType: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - resoucreType" - type: "string" - modelCustomizationName: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template\ - \ for the resource" - type: "string" - modelCustomizationId: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template\ - \ for the resource" - type: "string" - TargetServiceSchemaRef: - description: "" - required: - - "@type" - - "@schemaLocation" - type: "object" - properties: - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" diff --git a/docs/offeredapis/swaggers/serviceInventory_3_0_0.json b/docs/offeredapis/swaggers/serviceInventory_3_0_0.json deleted file mode 100644 index 3a5bfc1..0000000 --- a/docs/offeredapis/swaggers/serviceInventory_3_0_0.json +++ /dev/null @@ -1,614 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "serviceInventory API designed for ONAP Casablanca Release.\nThis API is build from TMF open API18.0 (applying TMF Guideline 3.0)\nonly operation GET (by id & byList) for resource serviceSpecification is available", - "version": "3.0.0", - "title": "API ServiceInventory", - "x-logo": { - "url": "/redoc/logo.png", - "backgroundColor": "#FFFFFF" - } - }, - - "host": "serverRoot", - "basePath": "/nbi/api/v3", - "schemes": [ - "https" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "Service", - "description": "" - } - ], - "paths": { - "/service": { - "get": { - "tags": [ - "Service" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceFind", - "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\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "relatedParty.id", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "serviceSpecification.id", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "serviceSpecification.name", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "id", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ListService" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/service/{id}": { - "get": { - "tags": [ - "Service" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceGet", - "summary": "Retrieve a service", - "description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "name": "relatedParty.id", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "serviceSpecification.id", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "serviceSpecification.name", - "required": false, - "in": "query", - "description": "", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Service" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - - "ErrorRepresentation": { - "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", - - - "required": [ - - "code", - "reason" - ], - "type": "object", - "properties": { - "code": { - "description": "Application related code (as defined in the API or from a common list)", - "type": "integer", - "format": "int32" - }, - "reason": { - "description": "Text that explains the reason for error. This can be shown to a client user.", - "type": "string" - }, - "message": { - "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user.", - "type": "string" - }, - "status": { - "description": "http error code extension like 400-2", - "type": "string" - }, - "referenceError": { - "description": "url pointing to documentation describing the error", - "type": "string" - }, - "@type": { - "description": "The class type of a REST resource.", - "type": "string" - }, - "@schemaLocation": { - "description": "it provides a link to the schema describing a REST resource.", - "type": "string" - } - } - - }, - - "Service": { - "description": "Instantiated service (service_instance) in AAI", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service - Valued with service-instance-id", - "type": "string" - }, - "href": { - "description": "Reference of the service\nNot managed in Beijing release", - "type": "string" - }, - "name": { - "description": "Name of the service - Valued with service-instance-name", - "type": "string" - }, - "type": { - "description": "Service type - valued with 'service-instance'", - "type": "string" - }, - "state": { - "description": "State of the service. Not managed in Beijing release", - "type": "string" - }, - "hasStarted": { - "description": "This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started\nNot managed in Beijing release", - "type": "boolean" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Not used in Beijing release.", - "type": "string" - }, - "@baseType": { - "description": "Not managed in Beijing release", - "type": "string" - }, - "@schemaLocation": { - "description": "Not managed in Beijing release", - "type": "string" - }, - "serviceSpecification": { - - "$ref": "#/definitions/ServiceSpecificationRef" - }, - "characteristic": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCharacteristic" - } - }, - "supportingResource": { - - "type": "array", - "items": { - "$ref": "#/definitions/SupportingResource" - } - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedPartyRef" - } - } - } - - }, - - "ServiceSpecificationRef": { - "description": "Service specification reference: ServiceSpecification of this service (catalog information)", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service specification. valued to model-version-id", - "type": "string" - }, - "href": { - "description": "Reference of the service specification.\nnot managed in Beijing release.", - "type": "string" - }, - "name": { - "description": "Name of the required service specification", - "type": "string" - }, - "version": { - "description": "Service specification version.\nNot managed in Beijing release", - "type": "string" - }, - "@referredType": { - "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID", - "type": "string" - }, - "@schemaLocation": { - "description": "Not managed in Beijing release", - "type": "string" - }, - "invariantUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id", - "type": "string" - } - } - - }, - - "ServiceCharacteristic": { - "description": "A list of name value pairs that define the service characteristics\nNot managed in Beijing release.", - - - "required": [ - - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "Name of the characteristic\nNot managed in Beijing release.", - "type": "string" - }, - "valueType": { - "description": "Type of value for this characteristic.\nNot managed in Beijing release.", - "type": "string" - }, - "value": { - - "$ref": "#/definitions/Value" - } - } - - }, - - "SupportingResource": { - "description": "Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the supporting resource - Valued to vnf-id", - "type": "string" - }, - "href": { - "description": "Reference of the supporting resource", - "type": "string" - }, - "role": { - "description": "Not managed in Beijing release.", - "type": "string" - }, - "name": { - "description": "Name of the supporting resource - Valued with vnf_-name", - "type": "string" - }, - "@referredType": { - "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:\n status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId", - "type": "string" - }, - "@schemaLocation": { - "description": "Not managed in Beijing release.", - "type": "string" - }, - "status": { - "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status", - "type": "string" - }, - "modelInvariantId": { - "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id", - "type": "string" - }, - "modelVersionId": { - "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id", - "type": "string" - }, - "modelCustomisationId": { - "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id", - "type": "string" - } - } - - }, - - "RelatedPartyRef": { - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.\nOnly ONAP Customer is managed in Beijing release.", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of a related party", - "type": "string" - }, - "href": { - "description": "Reference of a related party.\nNot filled in Beijing release.", - "type": "string" - }, - "role": { - "description": "Role played by the related party.\nFilled with 'ONAPcustomer'", - "type": "string" - }, - "@referredType": { - "description": "Not managed in the Beijing release.", - "type": "string" - } - } - - }, - - "Value": { - "description": "Structure used to describe characteristic value.\nNot managed in Beijing release.", - - - "type": "object", - "properties": { - "@type": { - "description": "Not managed in Beijing release.", - "type": "string" - }, - "@schemaLocation": { - "description": "Not managed in Beijing release.", - "type": "string" - }, - "serviceCharacteristicValue": { - "description": "Not managed in Beijing release.", - "type": "string" - } - } - - }, - - "ListRelatedPartyRef": { - "description": "This class is used to structure list of service(s) retrieved", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of a related party", - "type": "string" - }, - "role": { - "description": "Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.", - "type": "string" - } - } - - }, - - "ListServiceSpecificationRef": { - "description": "This class is used to structure list of service(s) retrieved", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service specification", - "type": "string" - }, - "name": { - "description": "Name of the required service specification", - "type": "string" - } - } - - }, - - "ListService": { - "description": "This class is used to structure list of service(s) retrieved", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service", - "type": "string" - }, - "name": { - "description": "Name of the service", - "type": "string" - }, - "serviceSpecification": { - - "$ref": "#/definitions/ListServiceSpecificationRef" - }, - "relatedParty": { - - "$ref": "#/definitions/ListRelatedPartyRef" - } - } - - } - } -} - \ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml b/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml deleted file mode 100644 index dd1097f..0000000 --- a/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml +++ /dev/null @@ -1,419 +0,0 @@ -swagger: "2.0" -info: - description: "serviceInventory API designed for ONAP Casablanca Release.\nThis API\ - \ is build from TMF open API18.0 (applying TMF Guideline 3.0)\nonly operation\ - \ GET (by id & byList) for resource serviceSpecification is available" - version: "3.0.0" - title: "API ServiceInventory" - x-logo: - url: "/redoc/logo.png" - backgroundColor: "#FFFFFF" -host: "serverRoot" -basePath: "/nbi/api/v3" -schemes: -- "https" -produces: -- "application/json;charset=utf-8" -tags: -- name: "Service" - description: "" -paths: - /service: - get: - tags: - - "Service" - produces: - - "application/json;charset=utf-8" - operationId: "serviceFind" - 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\n\nSpecific business errors for current operation will\ - \ be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "relatedParty.id" - required: false - in: "query" - description: "" - type: "string" - - name: "serviceSpecification.id" - required: false - in: "query" - description: "" - type: "string" - - name: "serviceSpecification.name" - required: false - in: "query" - description: "" - type: "string" - - name: "id" - required: false - in: "query" - description: "" - type: "string" - - name: "fields" - required: false - in: "query" - description: "" - type: "string" - responses: - 200: - description: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/ListService" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /service/{id}: - get: - tags: - - "Service" - produces: - - "application/json;charset=utf-8" - operationId: "serviceGet" - summary: "Retrieve a service" - description: "This operation retrieves a service entity. \nAttribute selection\ - \ is enabled for all first level attributes.\n\nSpecific business errors for\ - \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ - \ entity\n" - deprecated: false - parameters: - - name: "id" - in: "path" - required: true - type: "string" - description: "" - - name: "relatedParty.id" - required: false - in: "query" - description: "" - type: "string" - - name: "serviceSpecification.id" - required: false - in: "query" - description: "" - type: "string" - - name: "serviceSpecification.name" - required: false - in: "query" - description: "" - type: "string" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/Service" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - ErrorRepresentation: - description: "This class is used to describe error.\nfor nbi Beijing release we\ - \ do not manage additional error for serviceCatalog" - required: - - "code" - - "reason" - type: "object" - properties: - code: - description: "Application related code (as defined in the API or from a common\ - \ list)" - type: "integer" - format: "int32" - reason: - description: "Text that explains the reason for error. This can be shown to\ - \ a client user." - type: "string" - message: - description: "Text that provide more details and corrective actions related\ - \ to the error. This can be shown to a client user." - type: "string" - status: - description: "http error code extension like 400-2" - type: "string" - referenceError: - description: "url pointing to documentation describing the error" - type: "string" - '@type': - description: "The class type of a REST resource." - type: "string" - '@schemaLocation': - description: "it provides a link to the schema describing a REST resource." - type: "string" - Service: - description: "Instantiated service (service_instance) in AAI" - type: "object" - properties: - id: - description: "Unique identifier of the service - Valued with service-instance-id" - type: "string" - href: - description: "Reference of the service\nNot managed in Beijing release" - type: "string" - name: - description: "Name of the service - Valued with service-instance-name" - type: "string" - type: - description: "Service type - valued with 'service-instance'" - type: "string" - state: - description: "State of the service. Not managed in Beijing release" - type: "string" - hasStarted: - description: "This is a Boolean attribute that, if TRUE, signifies that this\ - \ Service has already been started. If the value of this attribute is FALSE,\ - \ then this signifies that this Service has NOT been Started\nNot managed\ - \ in Beijing release" - type: "boolean" - '@type': - description: "This attribute allows to dynamically extends TMF class. Not\ - \ used in Beijing release." - type: "string" - '@baseType': - description: "Not managed in Beijing release" - type: "string" - '@schemaLocation': - description: "Not managed in Beijing release" - type: "string" - serviceSpecification: - $ref: "#/definitions/ServiceSpecificationRef" - characteristic: - type: "array" - items: - $ref: "#/definitions/ServiceCharacteristic" - supportingResource: - type: "array" - items: - $ref: "#/definitions/SupportingResource" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedPartyRef" - ServiceSpecificationRef: - description: "Service specification reference: ServiceSpecification of this service\ - \ (catalog information)" - type: "object" - properties: - id: - description: "Unique identifier of the service specification. valued to model-version-id" - type: "string" - href: - description: "Reference of the service specification.\nnot managed in Beijing\ - \ release." - type: "string" - name: - description: "Name of the required service specification" - type: "string" - version: - description: "Service specification version.\nNot managed in Beijing release" - type: "string" - '@referredType': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with 'ONAPservice'. We used this features to add following attribute:\ - \ invariantUUID" - type: "string" - '@schemaLocation': - description: "Not managed in Beijing release" - type: "string" - invariantUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @referredType - model-invariant-id" - type: "string" - ServiceCharacteristic: - description: "A list of name value pairs that define the service characteristics\n\ - Not managed in Beijing release." - required: - - "name" - type: "object" - properties: - name: - description: "Name of the characteristic\nNot managed in Beijing release." - type: "string" - valueType: - description: "Type of value for this characteristic.\nNot managed in Beijing\ - \ release." - type: "string" - value: - $ref: "#/definitions/Value" - SupportingResource: - description: "Supporting resource - A supportingResource will be retrieved for\ - \ each relationship of the relationship-list where related-link describe a vnf" - type: "object" - properties: - id: - description: "Unique identifier of the supporting resource - Valued to vnf-id" - type: "string" - href: - description: "Reference of the supporting resource" - type: "string" - role: - description: "Not managed in Beijing release." - type: "string" - name: - description: "Name of the supporting resource - Valued with vnf_-name" - type: "string" - '@referredType': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with 'ONAP resource'. We used this features to add following attributes:\n\ - \ status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId" - type: "string" - '@schemaLocation': - description: "Not managed in Beijing release." - type: "string" - status: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @referredType - valued with prov-status" - type: "string" - modelInvariantId: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @referredType - valued with model-invariant-id" - type: "string" - modelVersionId: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @referredType - valued with model-verson-id" - type: "string" - modelCustomisationId: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @referredType - valued with model-customisation-id" - type: "string" - RelatedPartyRef: - description: "RelatedParty reference. A related party defines party or party role\ - \ linked to a specific entity.\nOnly ONAP Customer is managed in Beijing release." - type: "object" - properties: - id: - description: "Unique identifier of a related party" - type: "string" - href: - description: "Reference of a related party.\nNot filled in Beijing release." - type: "string" - role: - description: "Role played by the related party.\nFilled with 'ONAPcustomer'" - type: "string" - '@referredType': - description: "Not managed in the Beijing release." - type: "string" - Value: - description: "Structure used to describe characteristic value.\nNot managed in\ - \ Beijing release." - type: "object" - properties: - '@type': - description: "Not managed in Beijing release." - type: "string" - '@schemaLocation': - description: "Not managed in Beijing release." - type: "string" - serviceCharacteristicValue: - description: "Not managed in Beijing release." - type: "string" - ListRelatedPartyRef: - description: "This class is used to structure list of service(s) retrieved" - type: "object" - properties: - id: - description: "Unique identifier of a related party" - type: "string" - role: - description: "Role played by the related party - only role “ONAPcustomer”\ - \ is managed in Beijing release." - type: "string" - ListServiceSpecificationRef: - description: "This class is used to structure list of service(s) retrieved" - type: "object" - properties: - id: - description: "Unique identifier of the service specification" - type: "string" - name: - description: "Name of the required service specification" - type: "string" - ListService: - description: "This class is used to structure list of service(s) retrieved" - type: "object" - properties: - id: - description: "Unique identifier of the service" - type: "string" - name: - description: "Name of the service" - type: "string" - serviceSpecification: - $ref: "#/definitions/ListServiceSpecificationRef" - relatedParty: - $ref: "#/definitions/ListRelatedPartyRef" diff --git a/docs/offeredapis/swaggers/serviceOrder_3_0_0.json b/docs/offeredapis/swaggers/serviceOrder_3_0_0.json deleted file mode 100644 index 47a0113..0000000 --- a/docs/offeredapis/swaggers/serviceOrder_3_0_0.json +++ /dev/null @@ -1,2062 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "serviceOrder API designed for ONAP Casablanca release.\nThis API is build from TMF open API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list) and POST are available.", - "version": "3.0.0", - "title": "API ServiceOrder", - "x-logo": { - "url": "/redoc/logo.png", - "backgroundColor": "#FFFFFF" - } - }, - - "host": "serverRoot", - "basePath": "/nbi/api/v3", - "schemes": [ - "https" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "ServiceOrder", - "description": "A 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." - }, - { - "name": "Hub", - "description": "" - }, - { - "name": "Notification", - "description": "" - } - ], - "paths": { - "/serviceOrder": { - "post": { - "tags": [ - "ServiceOrder" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceOrderCreate", - "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.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add' action but serviceSpecification id missing\n \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing\n \n - 103: OrderItem with 'add' action but service id already existing in the inventory\n \n - 104: A customer for existing service(s) is provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory\n \n - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided\n ", - "deprecated": false, - - "parameters": [ - - { - "name": "serviceOrder", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/CreateServiceOrder" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceOrder" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated business errors for current operation\n\n - 100: OrderItem with 'add' action but serviceSpecification id missing\n \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing\n \n - 103: OrderItem with 'add' action but service id already existing in the inventory\n \n - 104: A customer for existing service(s) is provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory\n \n - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided\n ", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - }, - "get": { - "tags": [ - "ServiceOrder" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceOrderFind", - "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.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "externalId", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "state", - "required": false, - "in": "query", - "description": "state of the order(s) to be retrieved", - - "type": "string" - }, - { - "name": "description", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "orderDate.gt", - "required": false, - "in": "query", - "description": "order date greather than", - - "type": "string" - }, - { - "name": "orderDate.lt", - "required": false, - "in": "query", - "description": "order date lower than", - - "type": "string" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "this attribute could be used to filter retrieved attribute(s) and/or sort SO.", - - "type": "string" - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "The index of the first element to retrieve. Zero is the first element of the collection.", - - "type": "integer", - "format": "int32" - }, - { - "name": "limit", - "required": false, - "in": "query", - "description": "The maximum number of elements to retrieve (it can be greater than the actual available number of items).", - - "type": "integer", - "format": "int32" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceOrder" - } - }, - "headers": { - "X-Total-Count": { - "description": "", - "type": "integer", - "format": "int32" - }, - "X-Result-Count": { - "description": "", - "type": "integer", - "format": "int32" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/serviceOrder/{id}": { - "get": { - "tags": [ - "ServiceOrder" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "serviceOrderGet", - "summary": "Retrieve a service order", - "description": "This operation retrieves a service order entity. \nAttribute selection is enabled for all first level attributes.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "Attribute selection", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceOrder" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/hub": { - "post": { - "tags": [ - "Hub" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "operationId": "hubCreate", - "summary": "Create Hub", - "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "Hub", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/CreateHub" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "type": "file" - }, - "headers": { - "location": { - "description": "", - "type": "string" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - }, - "get": { - "tags": [ - "Hub" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "hubFind", - "summary": "Retrieve a lits of hub", - "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "eventType", - "required": false, - "in": "query", - "description": "", - - "type": "string", - "enum": [ - "ServiceOrderCreationNotification", - "ServiceOrderStateChangeNotification", - "ServiceOrderItemStateChangeNotification"] - - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Hub" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/hub/{hubId}": { - "get": { - "tags": [ - "Hub" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "operationId": "hubGet", - "summary": "Retrieve an HUB by id", - "description": "Retrieve an HUB by id\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "hubId", - "in": "path", - "required": true, - "type": "string", - "description": "" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Hub" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - }, - "delete": { - "tags": [ - "Hub" - ], - "operationId": "hubDelete", - "summary": "delete hub", - "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "hubId", - "in": "path", - "required": true, - "type": "string", - "description": "" - } - ], - "responses": { - "204": { - "description": "Success" - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/notification/serviceOrderCreationNotification": { - "post": { - "tags": [ - "Notification" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "operationId": "notificationServiceOrderCreationNotification", - "summary": "Service order creation notification", - "description": "Service order creation notification\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "serviceOrderCreationNotification", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/ServiceOrderCreationNotification" - } - } - ], - "responses": { - "204": { - "description": "Success" - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/notification/serviceOrderStateChangeNotification": { - "post": { - "tags": [ - "Notification" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "operationId": "notificationServiceOrderStateChangeNotification", - "summary": "Service order state change notification description", - "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "serviceOrderstateChangeNotification", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/ServiceOrderStateChangeNotification" - } - } - ], - "responses": { - "204": { - "description": "Success" - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/notification/serviceOrderItemStateChangeNotification": { - "post": { - "tags": [ - "Notification" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "operationId": "notificationServiceOrderItemStateChangeNotification", - "summary": "ServiceOrder Item State Change Notification description", - "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "serviceOrderItemStateChangeNotification", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/ServiceOrderItemStateChangeNotification" - } - } - ], - "responses": { - "204": { - "description": "Success" - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - "ActionType": { - "description": "Action type to be describer on the order item.\nmodify is not managed in Beijing release", - - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange"] - - }, - "StateType": { - "description": "List of possible state for the order and the orderItem.", - - "type": "string", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial"] - - }, - "RelationshipType": { - "description": "Relationship type;\nOnly reliesOn is managed in Beijing release.", - - "type": "string", - "enum": [ - "reliesOn"] - - }, - "EventType": { - "description": "", - - "type": "string", - "enum": [ - "ServiceOrderCreationNotification", - "ServiceOrderStateChangeNotification", - "ServiceOrderItemStateChangeNotification"] - - }, - "SeverityMessage": { - "description": "", - - "type": "string", - "enum": [ - "information", - "error"] - - }, - - "ErrorRepresentation": { - "description": "Representation of an error.", - - - "required": [ - - "code", - "reason" - ], - "type": "object", - "properties": { - "code": { - "description": "Application related code (as defined in the API or from a common list)", - "type": "integer", - "format": "int32" - }, - "reason": { - "description": "Text that explains the reason for error. This can be shown to a client user.", - "type": "string" - }, - "message": { - "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user", - "type": "string" - }, - "status": { - "description": "http error code extension like 400-2", - "type": "string" - }, - "referenceError": { - "description": "url pointing to documentation describing the error", - "type": "string" - }, - "@type": { - "description": "The class type of a REST resource", - "type": "string" - }, - "@schemaLocation": { - "description": "it provides a link to the schema describing a REST resource", - "type": "string" - } - } - - }, - - "ServiceRelationship": { - "description": "Linked Services to the one instantiate\nnbi component used this relationship to sort request to ONAP.", - - - "required": [ - - "type", - "service" - ], - "type": "object", - "properties": { - "type": { - - "$ref": "#/definitions/RelationshipType" - }, - "service": { - - "$ref": "#/definitions/Service" - } - } - - }, - - "ServiceRef": { - "description": "Service references", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service", - "type": "string" - }, - "href": { - "description": "Reference of the service", - "type": "string" - } - } - - }, - - "ServiceCharacteristic": { - "description": "ServiceCharacteristic", - - - "required": [ - - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "Name of characteristic", - "type": "string" - }, - "valueType": { - "description": "", - "type": "string" - }, - "value": { - - "$ref": "#/definitions/Value" - } - } - - }, - - "RelatedParty": { - "description": "A related party defines party which are involved in this order and the role they are playing.\nfor Beijing release:\nWith the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.\no\tIf no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.", - - - "required": [ - - "id", - "role" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of a related party", - "type": "string" - }, - "href": { - "description": "An hyperlink to the party - not used in Beijnig release", - "type": "string" - }, - "role": { - "description": "The role of the related party (e.g. Owner, requester, fullfiller etc).\nONLY 'ONAPcustomer' is considered", - "type": "string" - }, - "name": { - "description": "Name of the related party", - "type": "string" - }, - "@referredType": { - "description": "", - "type": "string" - } - } - - }, - - "ServiceSpecificationRef": { - "description": "The service specification (these attributes are fetched from the catalogue).", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service specification\nThis information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.", - "type": "string" - }, - "href": { - "description": "Reference of the service specification\nNot used in Beijing release.", - "type": "string" - }, - "name": { - "description": "Name of the service specification\nNot used in Beijing release", - "type": "string" - }, - "version": { - "description": "Version of the service Specification\nNot used in Beijing release", - "type": "string" - }, - "targetServiceSchema": { - - "$ref": "#/definitions/TargetServiceSchema" - }, - "@type": { - "description": "Not used in Beijing release", - "type": "string" - }, - "@schemaLocation": { - "description": "Not used in Beijing release", - "type": "string" - }, - "@baseType": { - "description": "Not used in Beijing release", - "type": "string" - } - } - - }, - - "Service": { - "description": "Service (to be added, modified, deleted) description", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of a service instance.\nIt must be valued if orderItem action is 'delete' and corresponds to a AAI service.id", - "type": "string" - }, - "href": { - "description": "Reference to the Service (useful for delete or modify command).\nNot managed in Beijing release.", - "type": "string" - }, - "name": { - "description": "Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.", - "type": "string" - }, - "serviceState": { - "description": "The lifecycle state of the service requested;\nNot managed in Beijing release.", - "type": "string" - }, - "@type": { - "description": "To define the service type\nNot managed in Beijing Release", - "type": "string" - }, - "@schemaLocation": { - "description": "The URL to get the resource schema.\nNot managed in Beijing Release", - "type": "string" - }, - "serviceCharacteristic": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCharacteristic" - } - }, - "serviceRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceRelationship" - } - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedParty" - } - }, - "serviceSpecification": { - - "$ref": "#/definitions/ServiceSpecificationRef" - } - } - - }, - - "OrderItemRelationship": { - "description": "Linked order item to the one containing this attribute.\nnbi component used this relationship to sort request to ONAP.", - - - "required": [ - - "type", - "id" - ], - "type": "object", - "properties": { - "type": { - - "$ref": "#/definitions/RelationshipType" - }, - "id": { - "description": "Unique identifier of an order item", - "type": "string" - } - } - - }, - - "ServiceOrderItem": { - "description": "An identified part of the order. A service order is decomposed into one or more order items.", - - - "required": [ - - "id", - "service" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", - "type": "string" - }, - "action": { - - "$ref": "#/definitions/ActionType" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "percentProgress": { - "description": "Progress of the delivery in percentage.", - "type": "string" - }, - "@type": { - "description": "Used to extend the order item.\nnot used in Beijing relase", - "type": "string" - }, - "@schemaLocation": { - "description": "not used in Beijing relase", - "type": "string" - }, - "@baseType": { - "description": "not used in Beijing relase", - "type": "string" - }, - "orderItemRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderItemRelationship" - } - }, - "service": { - - "$ref": "#/definitions/Service" - }, - "orderItemMessage": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderMessage" - } - } - } - - }, - - "ServiceOrder": { - "description": "A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "ID created on repository side", - "type": "string" - }, - "href": { - "description": "Hyperlink to access the order", - "type": "string" - }, - "externalId": { - "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", - "type": "string" - }, - "priority": { - "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", - "type": "string" - }, - "description": { - "description": "A free-text description of the service order", - "type": "string" - }, - "category": { - "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", - "type": "string" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "orderDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "completionDateTime": { - "description": "Date when the order was completed", - "type": "string", - "format": "date-time" - }, - "requestedStartDate": { - "description": "Order start date wished by the requestor", - "type": "string", - "format": "date-time" - }, - "requestedCompletionDate": { - "description": "Requested delivery date from the requestor perspective", - "type": "string", - "format": "date-time" - }, - "expectedCompletionDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "startDate": { - "description": "Date when the order was started for processing", - "type": "string", - "format": "date-time" - }, - "@baseType": { - "description": "", - "type": "string" - }, - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedParty" - } - }, - "orderRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderRelationship" - } - }, - "orderItem": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceOrderItem" - } - }, - "orderMessage": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderMessage" - } - } - } - - }, - - "OrderRelationship": { - "description": "Linked order to the one containing this attribute.\nThis relationship is not used to sort ONAP request.", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "type": { - "description": "The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)", - "type": "string" - }, - "id": { - "description": "The id of the related order", - "type": "string" - }, - "href": { - "description": "A hyperlink to the related order", - "type": "string" - }, - "@referredType": { - "description": "Type of the referred order.", - "type": "string" - } - } - - }, - - "TargetServiceSchema": { - "description": "Target to the schema describing the service spec resource", - - - "required": [ - - "@type", - "@schemaLocation" - ], - "type": "object", - "properties": { - "@type": { - "description": "Indicates the (class) type of resource.", - "type": "string" - }, - "@schemaLocation": { - "description": "This field provided a link to the schema describing this REST resource.", - "type": "string" - } - } - - }, - - "Value": { - "description": "Value is a descriptive structure for service characteristic;\nFor Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.", - - - "type": "object", - "properties": { - "@type": { - "description": "Indicates the (class) type of resource.\nNot used in Beijing Release", - "type": "string" - }, - "@schemaLocation": { - "description": "This field provided a link to the schema describing this REST resource.\nNot used in Beijing Release", - "type": "string" - }, - "serviceCharacteristicValue": { - "description": "Value of the characteristic.\nThis attribute must be used in Beijing Release to provide characteristic value.", - "type": "string" - } - } - - }, - - "CreateServiceOrderItem": { - "description": "This structure is used in the operation POST for a serviceOrder request to describe an item.\nAttribute description is not accurate and should be find in the serviceOrderItem class.", - - - "required": [ - - "id", - "service" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", - "type": "string" - }, - "action": { - - "$ref": "#/definitions/ActionType" - }, - "@type": { - "description": "Indicates the type of resource.", - "type": "string" - }, - "@schemaLocation": { - "description": "A link to the schema describing this REST resource", - "type": "string" - }, - "@baseType": { - "description": "Indicates the base type of the resource.", - "type": "string" - }, - "orderItemRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderItemRelationship" - } - }, - "service": { - - "$ref": "#/definitions/Service" - } - } - - }, - - "CreateServiceOrder": { - "description": "This structure is used in the operation POST for a serviceOrder request.\nAttribute description is not accurate and should be find in the serviceOrder class.", - - - "type": "object", - "properties": { - "externalId": { - "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", - "type": "string" - }, - "priority": { - "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", - "type": "string" - }, - "description": { - "description": "A free-text description of the service order", - "type": "string" - }, - "category": { - "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", - "type": "string" - }, - "requestedStartDate": { - "description": "Order start date wished by the requestor", - "type": "string", - "format": "date-time" - }, - "requestedCompletionDate": { - "description": "Requested delivery date from the requestor perspective", - "type": "string", - "format": "date-time" - }, - "@baseType": { - "description": "", - "type": "string" - }, - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedParty" - } - }, - "orderRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderRelationship" - } - }, - "orderItem": { - - "type": "array", - "items": { - "$ref": "#/definitions/CreateServiceOrderItem" - } - } - } - - }, - - "Hub": { - "description": "An HUB resource is used by client side to subscribe to notification.\nNot managed in the Beijing release.", - - - "discriminator": "id", - - "required": [ - - "query", - "callback" - ], - "type": "object", - "properties": { - "id": { - "description": "Hub Id", - "type": "string" - }, - "query": { - "description": "", - "type": "string" - }, - "callback": { - "description": "Address where notification must be send", - "type": "string" - } - } - - }, - - "CreateHub": { - "description": "This structure is used as a request for POST Hub operation", - - - "required": [ - - "query", - "callback" - ], - "type": "object", - "properties": { - "query": { - "description": "The query must have an eventType=notificationName information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED", - "type": "string" - }, - "callback": { - "description": "Address where notification must be send", - "type": "string" - } - } - - }, - - "ServiceOrderSummary": { - "description": "This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "ID created on repository side", - "type": "string" - }, - "href": { - "description": "Hyperlink to access the order", - "type": "string" - }, - "externalId": { - "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", - "type": "string" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "orderDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "completionDateTime": { - "description": "Date when the order was completed", - "type": "string", - "format": "date-time" - } - } - - }, - - "ServiceOrderCreationNotification": { - "description": "Notification structure for a service order creation notification", - - - "required": [ - - "eventId", - "eventDate", - "eventType", - "event" - ], - "type": "object", - "properties": { - "eventId": { - "description": "", - "type": "string" - }, - "eventDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "eventType": { - "description": "", - "type": "string", - - "default": "ServiceOrderCreationNotification" - }, - "event": { - - "$ref": "#/definitions/ServiceOrderSummary" - } - } - - }, - - "Notification": { - "description": "Used to describe notification for this API", - - - "type": "object", - "properties": { - } - - }, - - "ServiceOrderStateChangeNotification": { - "description": "Service order state change notification description", - - - "required": [ - - "eventId", - "eventDate", - "eventType", - "event" - ], - "type": "object", - "properties": { - "eventId": { - "description": "", - "type": "string" - }, - "eventDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "eventType": { - "description": "", - "type": "string", - - "default": "ServiceOrderStateChangeNotification" - }, - "event": { - - "$ref": "#/definitions/ServiceOrderSummary" - } - } - - }, - - "ServiceOrderItemSummary": { - "description": "Service Order item summary to be used for notification", - - - "required": [ - - "id", - "service" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", - "type": "string" - }, - "action": { - - "$ref": "#/definitions/ActionType" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "service": { - - "$ref": "#/definitions/Service" - } - } - - }, - - "ServiceOrderSummaryWithItem": { - "description": "Service order item summary with item description", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "ID created on repository side", - "type": "string" - }, - "href": { - "description": "Hyperlink to access the order", - "type": "string" - }, - "externalId": { - "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", - "type": "string" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "orderDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "completionDateTime": { - "description": "Date when the order was completed", - "type": "string", - "format": "date-time" - }, - "orderItem": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceOrderItemSummary" - } - } - } - - }, - - "ServiceOrderItemStateChangeNotification": { - "description": "", - - - "required": [ - - "eventId", - "eventDate", - "eventType", - "event" - ], - "type": "object", - "properties": { - "eventId": { - "description": "", - "type": "string" - }, - "eventDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "eventType": { - "description": "", - "type": "string", - - "default": "ServiceOrderStateChangeNotification" - }, - "event": { - - "$ref": "#/definitions/ServiceOrderSummaryWithItem" - } - } - - }, - - "OrderMessage": { - "description": "An optional array of messages associated with the Order", - - - "required": [ - - "severity", - "correctionRequired" - ], - "type": "object", - "properties": { - "code": { - "description": "A code associated to this message", - "type": "string" - }, - "field": { - "description": "Service Order attribute related to this error message", - "type": "string" - }, - "messageInformation": { - "description": "Message related to this order", - "type": "string" - }, - "severity": { - - "$ref": "#/definitions/SeverityMessage" - }, - "correctionRequired": { - "description": "Indicator that an action is required to allow service order fullfilment to follow up", - "type": "boolean" - } - } - - } - } -} - \ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml b/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml deleted file mode 100644 index db0479f..0000000 --- a/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml +++ /dev/null @@ -1,1428 +0,0 @@ -swagger: "2.0" -info: - description: "serviceOrder API designed for ONAP Casablanca release.\nThis API is build from TMF open\ - \ API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list)\ - \ and POST are available." - version: "3.0.0" - title: "API ServiceOrder" - x-logo: - url: "/redoc/logo.png" - backgroundColor: "#FFFFFF" -host: "serverRoot" -basePath: "/nbi/api/v3" -schemes: -- "https" -produces: -- "application/json;charset=utf-8" -tags: -- name: "ServiceOrder" - description: "A 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." -- name: "Hub" - description: "" -- name: "Notification" - description: "" -paths: - /serviceOrder: - post: - tags: - - "ServiceOrder" - consumes: - - "application/json;charset=utf-8" - produces: - - "application/json;charset=utf-8" - operationId: "serviceOrderCreate" - 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.\n\nSpecific business errors for current operation will be encapsulated\ - \ in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add'\ - \ action but serviceSpecification id missing\n \n - 101: OrderItem with\ - \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\ - \ with 'add' action - serviceSpecification id provided but not existing\n\ - \ \n - 103: OrderItem with 'add' action but service id already existing\ - \ in the inventory\n \n - 104: A customer for existing service(s) is provided\ - \ but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\ - \ - Service id provided but it is not existing in the inventory\n \n - 106:\ - \ [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId\ - \ provided\n " - deprecated: false - parameters: - - name: "serviceOrder" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/CreateServiceOrder" - responses: - 201: - description: "Success" - schema: - $ref: "#/definitions/ServiceOrder" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated\ - \ business errors for current operation\n\n - 100: OrderItem with 'add'\ - \ action but serviceSpecification id missing\n \n - 101: OrderItem with\ - \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\ - \ with 'add' action - serviceSpecification id provided but not existing\n\ - \ \n - 103: OrderItem with 'add' action but service id already existing\ - \ in the inventory\n \n - 104: A customer for existing service(s) is\ - \ provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\ - \ - Service id provided but it is not existing in the inventory\n \n\ - \ - 106: [Not managed for current Relese] Issue with lcpCloudRegionId\ - \ and tenantId provided\n " - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - get: - tags: - - "ServiceOrder" - produces: - - "application/json;charset=utf-8" - operationId: "serviceOrderFind" - 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\ - \ be described in the fields attribute.\n\nSpecific business errors for current\ - \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "externalId" - required: false - in: "query" - description: "" - type: "string" - - name: "state" - required: false - in: "query" - description: "state of the order(s) to be retrieved" - type: "string" - - name: "description" - required: false - in: "query" - description: "" - type: "string" - - name: "orderDate.gt" - required: false - in: "query" - description: "order date greather than" - type: "string" - - name: "orderDate.lt" - required: false - in: "query" - description: "order date lower than" - type: "string" - - name: "fields" - required: false - in: "query" - description: "this attribute could be used to filter retrieved attribute(s)\ - \ and/or sort SO." - type: "string" - - name: "offset" - required: false - in: "query" - description: "The index of the first element to retrieve. Zero is the first\ - \ element of the collection." - type: "integer" - format: "int32" - - name: "limit" - required: false - in: "query" - description: "The maximum number of elements to retrieve (it can be greater\ - \ than the actual available number of items)." - type: "integer" - format: "int32" - responses: - 200: - description: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/ServiceOrder" - headers: - X-Total-Count: - description: "" - type: "integer" - format: "int32" - X-Result-Count: - description: "" - type: "integer" - format: "int32" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /serviceOrder/{id}: - get: - tags: - - "ServiceOrder" - produces: - - "application/json;charset=utf-8" - operationId: "serviceOrderGet" - summary: "Retrieve a service order" - description: "This operation retrieves a service order entity. \nAttribute selection\ - \ is enabled for all first level attributes.\n\nSpecific business errors for\ - \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ - \ entity\n" - deprecated: false - parameters: - - name: "id" - in: "path" - required: true - type: "string" - description: "" - - name: "fields" - required: false - in: "query" - description: "Attribute selection" - type: "string" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/ServiceOrder" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /hub: - post: - tags: - - "Hub" - consumes: - - "application/json;charset=utf-8" - operationId: "hubCreate" - summary: "Create Hub" - description: "\n\nSpecific business errors for current operation will be encapsulated\ - \ in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "Hub" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/CreateHub" - responses: - 201: - description: "Success" - schema: - type: "file" - headers: - location: - description: "" - type: "string" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - get: - tags: - - "Hub" - produces: - - "application/json;charset=utf-8" - operationId: "hubFind" - summary: "Retrieve a lits of hub" - description: "\n\nSpecific business errors for current operation will be encapsulated\ - \ in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "id" - required: false - in: "query" - description: "" - type: "string" - - name: "eventType" - required: false - in: "query" - description: "" - type: "string" - enum: - - "ServiceOrderCreationNotification" - - "ServiceOrderStateChangeNotification" - - "ServiceOrderItemStateChangeNotification" - responses: - 200: - description: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/Hub" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /hub/{hubId}: - get: - tags: - - "Hub" - produces: - - "application/json;charset=utf-8" - operationId: "hubGet" - summary: "Retrieve an HUB by id" - description: "Retrieve an HUB by id\n\nSpecific business errors for current\ - \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "hubId" - in: "path" - required: true - type: "string" - description: "" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/Hub" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - delete: - tags: - - "Hub" - operationId: "hubDelete" - summary: "delete hub" - description: "\n\nSpecific business errors for current operation will be encapsulated\ - \ in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "hubId" - in: "path" - required: true - type: "string" - description: "" - responses: - 204: - description: "Success" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /notification/serviceOrderCreationNotification: - post: - tags: - - "Notification" - consumes: - - "application/json;charset=utf-8" - operationId: "notificationServiceOrderCreationNotification" - summary: "Service order creation notification" - description: "Service order creation notification\n\nSpecific business errors\ - \ for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ - \ entity\n" - deprecated: false - parameters: - - name: "serviceOrderCreationNotification" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/ServiceOrderCreationNotification" - responses: - 204: - description: "Success" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /notification/serviceOrderStateChangeNotification: - post: - tags: - - "Notification" - consumes: - - "application/json;charset=utf-8" - operationId: "notificationServiceOrderStateChangeNotification" - summary: "Service order state change notification description" - description: "\n\nSpecific business errors for current operation will be encapsulated\ - \ in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "serviceOrderstateChangeNotification" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/ServiceOrderStateChangeNotification" - responses: - 204: - description: "Success" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /notification/serviceOrderItemStateChangeNotification: - post: - tags: - - "Notification" - consumes: - - "application/json;charset=utf-8" - operationId: "notificationServiceOrderItemStateChangeNotification" - summary: "ServiceOrder Item State Change Notification description" - description: "\n\nSpecific business errors for current operation will be encapsulated\ - \ in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "serviceOrderItemStateChangeNotification" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/ServiceOrderItemStateChangeNotification" - responses: - 204: - description: "Success" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - ActionType: - description: "Action type to be describer on the order item.\nmodify is not managed\ - \ in Beijing release" - type: "string" - enum: - - "add" - - "modify" - - "delete" - - "noChange" - StateType: - description: "List of possible state for the order and the orderItem." - type: "string" - enum: - - "acknowledged" - - "rejected" - - "pending" - - "held" - - "inProgress" - - "cancelled" - - "completed" - - "failed" - - "partial" - RelationshipType: - description: "Relationship type;\nOnly reliesOn is managed in Beijing release." - type: "string" - enum: - - "reliesOn" - EventType: - description: "" - type: "string" - enum: - - "ServiceOrderCreationNotification" - - "ServiceOrderStateChangeNotification" - - "ServiceOrderItemStateChangeNotification" - SeverityMessage: - description: "" - type: "string" - enum: - - "information" - - "error" - ErrorRepresentation: - description: "Representation of an error." - required: - - "code" - - "reason" - type: "object" - properties: - code: - description: "Application related code (as defined in the API or from a common\ - \ list)" - type: "integer" - format: "int32" - reason: - description: "Text that explains the reason for error. This can be shown to\ - \ a client user." - type: "string" - message: - description: "Text that provide more details and corrective actions related\ - \ to the error. This can be shown to a client user" - type: "string" - status: - description: "http error code extension like 400-2" - type: "string" - referenceError: - description: "url pointing to documentation describing the error" - type: "string" - '@type': - description: "The class type of a REST resource" - type: "string" - '@schemaLocation': - description: "it provides a link to the schema describing a REST resource" - type: "string" - ServiceRelationship: - description: "Linked Services to the one instantiate\nnbi component used this\ - \ relationship to sort request to ONAP." - required: - - "type" - - "service" - type: "object" - properties: - type: - $ref: "#/definitions/RelationshipType" - service: - $ref: "#/definitions/Service" - ServiceRef: - description: "Service references" - required: - - "id" - type: "object" - properties: - id: - description: "Unique identifier of the service" - type: "string" - href: - description: "Reference of the service" - type: "string" - ServiceCharacteristic: - description: "ServiceCharacteristic" - required: - - "name" - type: "object" - properties: - name: - description: "Name of characteristic" - type: "string" - valueType: - description: "" - type: "string" - value: - $ref: "#/definitions/Value" - RelatedParty: - description: "A related party defines party which are involved in this order and\ - \ the role they are playing.\nfor Beijing release:\nWith the current version\ - \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\ - \ concept is confusing with Customer BSS concept. We took the following rules\ - \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\ - \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\ - \ in the serviceOrder header (we will not consider in this release the party\ - \ at item level); External API component will check if this customer exists\ - \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\ - \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\ - generic’ customer always exists." - required: - - "id" - - "role" - type: "object" - properties: - id: - description: "Unique identifier of a related party" - type: "string" - href: - description: "An hyperlink to the party - not used in Beijnig release" - type: "string" - role: - description: "The role of the related party (e.g. Owner, requester, fullfiller\ - \ etc).\nONLY 'ONAPcustomer' is considered" - type: "string" - name: - description: "Name of the related party" - type: "string" - '@referredType': - description: "" - type: "string" - ServiceSpecificationRef: - description: "The service specification (these attributes are fetched from the\ - \ catalogue)." - required: - - "id" - type: "object" - properties: - id: - description: "Unique identifier of the service specification\nThis information\ - \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\ - \ the request." - type: "string" - href: - description: "Reference of the service specification\nNot used in Beijing\ - \ release." - type: "string" - name: - description: "Name of the service specification\nNot used in Beijing release" - type: "string" - version: - description: "Version of the service Specification\nNot used in Beijing release" - type: "string" - targetServiceSchema: - $ref: "#/definitions/TargetServiceSchema" - '@type': - description: "Not used in Beijing release" - type: "string" - '@schemaLocation': - description: "Not used in Beijing release" - type: "string" - '@baseType': - description: "Not used in Beijing release" - type: "string" - Service: - description: "Service (to be added, modified, deleted) description" - required: - - "id" - type: "object" - properties: - id: - description: "Identifier of a service instance.\nIt must be valued if orderItem\ - \ action is 'delete' and corresponds to a AAI service.id" - type: "string" - href: - description: "Reference to the Service (useful for delete or modify command).\n\ - Not managed in Beijing release." - type: "string" - name: - description: "Name of the service - When orderItem action is 'add' this name\ - \ will be used in ONAP/SO request as InstaceName." - type: "string" - serviceState: - description: "The lifecycle state of the service requested;\nNot managed in\ - \ Beijing release." - type: "string" - '@type': - description: "To define the service type\nNot managed in Beijing Release" - type: "string" - '@schemaLocation': - description: "The URL to get the resource schema.\nNot managed in Beijing\ - \ Release" - type: "string" - serviceCharacteristic: - type: "array" - items: - $ref: "#/definitions/ServiceCharacteristic" - serviceRelationship: - type: "array" - items: - $ref: "#/definitions/ServiceRelationship" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedParty" - serviceSpecification: - $ref: "#/definitions/ServiceSpecificationRef" - OrderItemRelationship: - description: "Linked order item to the one containing this attribute.\nnbi component\ - \ used this relationship to sort request to ONAP." - required: - - "type" - - "id" - type: "object" - properties: - type: - $ref: "#/definitions/RelationshipType" - id: - description: "Unique identifier of an order item" - type: "string" - ServiceOrderItem: - description: "An identified part of the order. A service order is decomposed into\ - \ one or more order items." - required: - - "id" - - "service" - type: "object" - properties: - id: - description: "Identifier of the line item (generally it is a sequence number\ - \ 01, 02, 03, …)" - type: "string" - action: - $ref: "#/definitions/ActionType" - state: - $ref: "#/definitions/StateType" - percentProgress: - description: "Progress of the delivery in percentage." - type: "string" - '@type': - description: "Used to extend the order item.\nnot used in Beijing relase" - type: "string" - '@schemaLocation': - description: "not used in Beijing relase" - type: "string" - '@baseType': - description: "not used in Beijing relase" - type: "string" - orderItemRelationship: - type: "array" - items: - $ref: "#/definitions/OrderItemRelationship" - service: - $ref: "#/definitions/Service" - orderItemMessage: - type: "array" - items: - $ref: "#/definitions/OrderMessage" - ServiceOrder: - description: "A Service Order is a type of order which can be used to place an\ - \ order between a customer and a service provider or between a service provider\ - \ and a partner and vice versa" - required: - - "id" - type: "object" - properties: - id: - description: "ID created on repository side" - type: "string" - href: - description: "Hyperlink to access the order" - type: "string" - externalId: - description: "ID given by the consumer and only understandable by him (to\ - \ facilitate his searches)" - type: "string" - priority: - description: "A way that can be used by consumers to prioritize orders in\ - \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ - \ and 4 the lowest)" - type: "string" - description: - description: "A free-text description of the service order" - type: "string" - category: - description: "Used to categorize the order that can be useful for the OM system\ - \ (e.g. “broadband”, “TVOption”, ...)" - type: "string" - state: - $ref: "#/definitions/StateType" - orderDate: - description: "" - type: "string" - format: "date-time" - completionDateTime: - description: "Date when the order was completed" - type: "string" - format: "date-time" - requestedStartDate: - description: "Order start date wished by the requestor" - type: "string" - format: "date-time" - requestedCompletionDate: - description: "Requested delivery date from the requestor perspective" - type: "string" - format: "date-time" - expectedCompletionDate: - description: "" - type: "string" - format: "date-time" - startDate: - description: "Date when the order was started for processing" - type: "string" - format: "date-time" - '@baseType': - description: "" - type: "string" - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedParty" - orderRelationship: - type: "array" - items: - $ref: "#/definitions/OrderRelationship" - orderItem: - type: "array" - items: - $ref: "#/definitions/ServiceOrderItem" - orderMessage: - type: "array" - items: - $ref: "#/definitions/OrderMessage" - OrderRelationship: - description: "Linked order to the one containing this attribute.\nThis relationship\ - \ is not used to sort ONAP request." - required: - - "id" - type: "object" - properties: - type: - description: "The type of related order, can be : “dependency” if the order\ - \ needs to be “not started” until another order item is complete (a service\ - \ order in this case) or “cross-ref” to keep track of the source order (a\ - \ productOrder)" - type: "string" - id: - description: "The id of the related order" - type: "string" - href: - description: "A hyperlink to the related order" - type: "string" - '@referredType': - description: "Type of the referred order." - type: "string" - TargetServiceSchema: - description: "Target to the schema describing the service spec resource" - required: - - "@type" - - "@schemaLocation" - type: "object" - properties: - '@type': - description: "Indicates the (class) type of resource." - type: "string" - '@schemaLocation': - description: "This field provided a link to the schema describing this REST\ - \ resource." - type: "string" - Value: - description: "Value is a descriptive structure for service characteristic;\nFor\ - \ Beijing we only manage 'basic' attribute - the serviceCharacteristicValue\ - \ must be used." - type: "object" - properties: - '@type': - description: "Indicates the (class) type of resource.\nNot used in Beijing\ - \ Release" - type: "string" - '@schemaLocation': - description: "This field provided a link to the schema describing this REST\ - \ resource.\nNot used in Beijing Release" - type: "string" - serviceCharacteristicValue: - description: "Value of the characteristic.\nThis attribute must be used in\ - \ Beijing Release to provide characteristic value." - type: "string" - CreateServiceOrderItem: - description: "This structure is used in the operation POST for a serviceOrder\ - \ request to describe an item.\nAttribute description is not accurate and should\ - \ be find in the serviceOrderItem class." - required: - - "id" - - "service" - type: "object" - properties: - id: - description: "Identifier of the line item (generally it is a sequence number\ - \ 01, 02, 03, …)" - type: "string" - action: - $ref: "#/definitions/ActionType" - '@type': - description: "Indicates the type of resource." - type: "string" - '@schemaLocation': - description: "A link to the schema describing this REST resource" - type: "string" - '@baseType': - description: "Indicates the base type of the resource." - type: "string" - orderItemRelationship: - type: "array" - items: - $ref: "#/definitions/OrderItemRelationship" - service: - $ref: "#/definitions/Service" - CreateServiceOrder: - description: "This structure is used in the operation POST for a serviceOrder\ - \ request.\nAttribute description is not accurate and should be find in the\ - \ serviceOrder class." - type: "object" - properties: - externalId: - description: "ID given by the consumer and only understandable by him (to\ - \ facilitate his searches)" - type: "string" - priority: - description: "A way that can be used by consumers to prioritize orders in\ - \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ - \ and 4 the lowest)" - type: "string" - description: - description: "A free-text description of the service order" - type: "string" - category: - description: "Used to categorize the order that can be useful for the OM system\ - \ (e.g. “broadband”, “TVOption”, ...)" - type: "string" - requestedStartDate: - description: "Order start date wished by the requestor" - type: "string" - format: "date-time" - requestedCompletionDate: - description: "Requested delivery date from the requestor perspective" - type: "string" - format: "date-time" - '@baseType': - description: "" - type: "string" - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedParty" - orderRelationship: - type: "array" - items: - $ref: "#/definitions/OrderRelationship" - orderItem: - type: "array" - items: - $ref: "#/definitions/CreateServiceOrderItem" - Hub: - description: "An HUB resource is used by client side to subscribe to notification.\n\ - Not managed in the Beijing release." - discriminator: "id" - required: - - "query" - - "callback" - type: "object" - properties: - id: - description: "Hub Id" - type: "string" - query: - description: "" - type: "string" - callback: - description: "Address where notification must be send" - type: "string" - CreateHub: - description: "This structure is used as a request for POST Hub operation" - required: - - "query" - - "callback" - type: "object" - properties: - query: - description: "The query must have an eventType=notificationName information.\n\ - Optionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”\ - &serviceOrder.state=COMPLETED" - type: "string" - callback: - description: "Address where notification must be send" - type: "string" - ServiceOrderSummary: - description: "This structure is used to provide a subset of serviceOrder attributes\ - \ to be provided in particular for notification messages" - required: - - "id" - type: "object" - properties: - id: - description: "ID created on repository side" - type: "string" - href: - description: "Hyperlink to access the order" - type: "string" - externalId: - description: "ID given by the consumer and only understandable by him (to\ - \ facilitate his searches)" - type: "string" - state: - $ref: "#/definitions/StateType" - orderDate: - description: "" - type: "string" - format: "date-time" - completionDateTime: - description: "Date when the order was completed" - type: "string" - format: "date-time" - ServiceOrderCreationNotification: - description: "Notification structure for a service order creation notification" - required: - - "eventId" - - "eventDate" - - "eventType" - - "event" - type: "object" - properties: - eventId: - description: "" - type: "string" - eventDate: - description: "" - type: "string" - format: "date-time" - eventType: - description: "" - type: "string" - default: "ServiceOrderCreationNotification" - event: - $ref: "#/definitions/ServiceOrderSummary" - Notification: - description: "Used to describe notification for this API" - type: "object" - properties: {} - ServiceOrderStateChangeNotification: - description: "Service order state change notification description" - required: - - "eventId" - - "eventDate" - - "eventType" - - "event" - type: "object" - properties: - eventId: - description: "" - type: "string" - eventDate: - description: "" - type: "string" - format: "date-time" - eventType: - description: "" - type: "string" - default: "ServiceOrderStateChangeNotification" - event: - $ref: "#/definitions/ServiceOrderSummary" - ServiceOrderItemSummary: - description: "Service Order item summary to be used for notification" - required: - - "id" - - "service" - type: "object" - properties: - id: - description: "Identifier of the line item (generally it is a sequence number\ - \ 01, 02, 03, …)" - type: "string" - action: - $ref: "#/definitions/ActionType" - state: - $ref: "#/definitions/StateType" - service: - $ref: "#/definitions/Service" - ServiceOrderSummaryWithItem: - description: "Service order item summary with item description" - required: - - "id" - type: "object" - properties: - id: - description: "ID created on repository side" - type: "string" - href: - description: "Hyperlink to access the order" - type: "string" - externalId: - description: "ID given by the consumer and only understandable by him (to\ - \ facilitate his searches)" - type: "string" - state: - $ref: "#/definitions/StateType" - orderDate: - description: "" - type: "string" - format: "date-time" - completionDateTime: - description: "Date when the order was completed" - type: "string" - format: "date-time" - orderItem: - type: "array" - items: - $ref: "#/definitions/ServiceOrderItemSummary" - ServiceOrderItemStateChangeNotification: - description: "" - required: - - "eventId" - - "eventDate" - - "eventType" - - "event" - type: "object" - properties: - eventId: - description: "" - type: "string" - eventDate: - description: "" - type: "string" - format: "date-time" - eventType: - description: "" - type: "string" - default: "ServiceOrderStateChangeNotification" - event: - $ref: "#/definitions/ServiceOrderSummaryWithItem" - OrderMessage: - description: "An optional array of messages associated with the Order" - required: - - "severity" - - "correctionRequired" - type: "object" - properties: - code: - description: "A code associated to this message" - type: "string" - field: - description: "Service Order attribute related to this error message" - type: "string" - messageInformation: - description: "Message related to this order" - type: "string" - severity: - $ref: "#/definitions/SeverityMessage" - correctionRequired: - description: "Indicator that an action is required to allow service order\ - \ fullfilment to follow up" - type: "boolean" -- cgit 1.2.3-korg