From 8f141d17f3ea7720df479f4ae51b5a2e169548cb Mon Sep 17 00:00:00 2001 From: romaingimbert Date: Fri, 14 Sep 2018 14:52:20 +0200 Subject: [PATCH] Add API Documentation for Casablanca -update docs -update version related code -change properties MSB Change-Id: I7fb2a257ec035c53e93666d7571a2c74a0624524 Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert --- .env | 7 +- docs/architecture/NBI_Developer_Guide.rst | 2 +- docs/configuration/configuration.rst | 4 +- docs/installation/installation.rst | 4 +- .../images/ONAP_External_ID_Beijing.jpg | Bin .../images/ONAP_External_ID_Casablanca.jpg | Bin docs/offeredapis/images/html.png | Bin docs/offeredapis/images/notification.jpg | Bin docs/offeredapis/images/pdf.png | Bin docs/offeredapis/images/postman.png | Bin docs/offeredapis/images/swagger.png | Bin docs/offeredapis/images/swaggerUI.png | Bin docs/offeredapis/images/uml.jpg | Bin docs/offeredapis/index.rst | 16 +- 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 | 19 +- docs/offeredapis/pdf/nbicallflow.pdf | Bin .../serviceCatalog/apiServiceCatalog.plantuml | 4 - docs/offeredapis/serviceCatalog/asciiDoc.adoc | 29 +- docs/offeredapis/serviceCatalog/documentation.html | 49 +- docs/offeredapis/serviceCatalog/markDown.md | 27 +- .../serviceInventory/apiServiceInventory.plantuml | 14 +- docs/offeredapis/serviceInventory/asciiDoc.adoc | 36 +- .../serviceInventory/documentation.html | 60 +- docs/offeredapis/serviceInventory/markDown.md | 34 +- .../serviceOrder/apiServiceOrder.plantuml | 78 +- docs/offeredapis/serviceOrder/asciiDoc.adoc | 826 ++++++- docs/offeredapis/serviceOrder/documentation.html | 2364 ++++++++++++++++---- docs/offeredapis/serviceOrder/markDown.md | 461 +++- 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 ++++++++++++ docs/releasenotes/releasenotes.rst | 122 + restclient/.vscode/settings.json | 2 +- .../java/org/onap/nbi/ServiceRegisterRunner.java | 6 +- .../org/onap/nbi/apis/status/StatusResource.java | 13 +- src/main/resources/application.properties | 9 +- .../java/org/onap/nbi/apis/StatusResourceTest.java | 11 +- src/test/resources/application.properties | 9 +- 47 files changed, 10650 insertions(+), 686 deletions(-) mode change 100755 => 100644 docs/offeredapis/images/ONAP_External_ID_Beijing.jpg mode change 100755 => 100644 docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg mode change 100755 => 100644 docs/offeredapis/images/html.png mode change 100755 => 100644 docs/offeredapis/images/notification.jpg mode change 100755 => 100644 docs/offeredapis/images/pdf.png mode change 100755 => 100644 docs/offeredapis/images/postman.png mode change 100755 => 100644 docs/offeredapis/images/swagger.png mode change 100755 => 100644 docs/offeredapis/images/swaggerUI.png mode change 100755 => 100644 docs/offeredapis/images/uml.jpg mode change 100755 => 100644 docs/offeredapis/index.rst create mode 100644 docs/offeredapis/listener/apiListener.plantuml create mode 100644 docs/offeredapis/listener/asciiDoc.adoc create mode 100644 docs/offeredapis/listener/documentation.html create mode 100644 docs/offeredapis/listener/markDown.md mode change 100755 => 100644 docs/offeredapis/offeredapis.rst mode change 100755 => 100644 docs/offeredapis/pdf/nbicallflow.pdf create mode 100644 docs/offeredapis/swaggers/listener-1_0_0.json create mode 100644 docs/offeredapis/swaggers/listener-1_0_0.yaml create mode 100644 docs/offeredapis/swaggers/serviceCatalog_3_0_0.json create mode 100644 docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml create mode 100644 docs/offeredapis/swaggers/serviceInventory_3_0_0.json create mode 100644 docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml create mode 100644 docs/offeredapis/swaggers/serviceOrder_3_0_0.json create mode 100644 docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml create mode 100755 docs/releasenotes/releasenotes.rst diff --git a/.env b/.env index 71f7de7..0aba3a4 100644 --- a/.env +++ b/.env @@ -14,6 +14,8 @@ # limitations under the License. # +NBI_VERSION=v3 + # APPLICATION SERVER_CONTEXTPATH=/nbi/api/v3 SERVER_PORT=8080 @@ -44,14 +46,11 @@ SO_HEADER_AUTHORIZATION= SO_API_ID=SO # MSB -MSB_ENABLED=true +MSB_ENABLED=false MSB_DISCOVERY_HOST=msb_discovery -MSB_DISCOVERY_PORT=10081 MSB_SERVICE_HOST= MSB_SERVICE_PORT=8080 MSB_SERVICE_NAME=nbi -MSB_SERVICE_VERSION=v1 -MSB_SERVICE_URL=/nbi/api/v1 MSB_SERVICE_CUSTOM_PATH= MSB_SERVICE_PROTOCOL=REST MSB_SERVICE_VISUAL_RANGE=1 diff --git a/docs/architecture/NBI_Developer_Guide.rst b/docs/architecture/NBI_Developer_Guide.rst index 1a421f6..6a38891 100644 --- a/docs/architecture/NBI_Developer_Guide.rst +++ b/docs/architecture/NBI_Developer_Guide.rst @@ -83,7 +83,7 @@ You can view the log output of the application with the following command: **Testing** When the application is running, you can access the API at -:samp:`http://yourhostname:8080/nbi/api/v1` and fill the URL with the name +:samp:`http://yourhostname:8080/nbi/api/v3` and fill the URL with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status) You can run a test by using `VisualStudio RestClient plugin `_ diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst index 1ec4054..22bd5fd 100644 --- a/docs/configuration/configuration.rst +++ b/docs/configuration/configuration.rst @@ -23,7 +23,7 @@ Default values :: # SERVER - server.contextPath=/nbi/api/v1 + server.contextPath=/nbi/api/v3 server.port = 8080 # LOGGING @@ -35,7 +35,7 @@ Default values onap.cloudOwner=CloudOwner # NBI - nbi.url=http://localhost:8080/nbi/api/v1 + nbi.url=http://localhost:8080/nbi/api/v3 nbi.callForVNF=false # SDC diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst index 5fce7b8..89a55fb 100644 --- a/docs/installation/installation.rst +++ b/docs/installation/installation.rst @@ -79,14 +79,14 @@ Test **Healthcheck** -http://localhost:8080/nbi/api/v1/status +http://localhost:8080/nbi/api/v3/status You should get:: { "name": "nbi", "status": "ok", - "version": "v1" + "version": "v3" } **Play with RESTclient** diff --git a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg b/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/html.png b/docs/offeredapis/images/html.png old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/notification.jpg b/docs/offeredapis/images/notification.jpg old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/pdf.png b/docs/offeredapis/images/pdf.png old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/postman.png b/docs/offeredapis/images/postman.png old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/swagger.png b/docs/offeredapis/images/swagger.png old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/swaggerUI.png b/docs/offeredapis/images/swaggerUI.png old mode 100755 new mode 100644 diff --git a/docs/offeredapis/images/uml.jpg b/docs/offeredapis/images/uml.jpg old mode 100755 new mode 100644 diff --git a/docs/offeredapis/index.rst b/docs/offeredapis/index.rst old mode 100755 new mode 100644 index 0146813..fbb0948 --- a/docs/offeredapis/index.rst +++ b/docs/offeredapis/index.rst @@ -25,7 +25,7 @@ Following illustration provides a global view about nbi architecture,integration API Version *********** -APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v1/productOrder'. +APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v3/productOrder'. The schema associated with a REST API must have its version number aligned with that of the REST API. The version number has major, minor and revision numbers. E.g. v1.0.0 @@ -72,9 +72,9 @@ API Table :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" + "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" *************** @@ -98,7 +98,7 @@ Only ‘basic’ service characteristics will be managed in this release. By ‘ GET serviceSpecification(list) -(example: GET /nbi/api/v1/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) +(example: GET /nbi/api/v3/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) It is possible to retrieve a list of serviceSpecification (get by list). @@ -108,7 +108,7 @@ if no serviceSpecification matches, an empty list is send back. GET tservice Specification (id) -(example: GET /nbi/api/v1/serviceSpecification/{uuid}) +(example: GET /nbi/api/v3/serviceSpecification/{uuid}) It is use to retrieve one serviceSpecification - all available information are retieved (see swagger for description) @@ -124,7 +124,7 @@ This API retrieves service(s) in the AAI inventory. Only following attributes wi GET Service Inventory (list): -(example: GET /nbi/api/v1/service/?relatedParty.id=Pontus +(example: GET /nbi/api/v3/service/?relatedParty.id=Pontus ) GET (by list) allows to request with following criteria (all optional) : @@ -143,7 +143,7 @@ if no service matches, an empty list is send back. GET Service Inventory (id): -(example: GET /nbi/api/v1/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) +(example: GET /nbi/api/v3/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) Because of AAI capability, additionally to the service id, customer id and [serviceSpecification.id or serviceSpecification.name] must be supplied. If the customer id is not supplied, External API will use ‘generic’ customer diff --git a/docs/offeredapis/listener/apiListener.plantuml b/docs/offeredapis/listener/apiListener.plantuml new file mode 100644 index 0000000..fe5ebc8 --- /dev/null +++ b/docs/offeredapis/listener/apiListener.plantuml @@ -0,0 +1,26 @@ +@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 new file mode 100644 index 0000000..dcbb054 --- /dev/null +++ b/docs/offeredapis/listener/asciiDoc.adoc @@ -0,0 +1,175 @@ += 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 new file mode 100644 index 0000000..58cb7e2 --- /dev/null +++ b/docs/offeredapis/listener/documentation.html @@ -0,0 +1,779 @@ + + + + + + + +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 new file mode 100644 index 0000000..332c6cf --- /dev/null +++ b/docs/offeredapis/listener/markDown.md @@ -0,0 +1,122 @@ +# 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 old mode 100755 new mode 100644 index c2d1cdd..4ecfdd9 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -25,7 +25,7 @@ Following illustration provides a global view about nbi architecture,integration API Version *********** -APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v1/productOrder'. +APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v3/productOrder'. The schema associated with a REST API must have its version number aligned with that of the REST API. The version number has major, minor and revision numbers. E.g. v1.0.0 @@ -74,11 +74,12 @@ API Table :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" - + "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" + *************** API Description *************** @@ -100,7 +101,7 @@ Only ‘basic’ service characteristics will be managed in this release. By ‘ GET serviceSpecification(list) -(example: GET /nbi/api/v1/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) +(example: GET /nbi/api/v3/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) It is possible to retrieve a list of serviceSpecification (get by list). @@ -110,7 +111,7 @@ if no serviceSpecification matches, an empty list is send back. GET tservice Specification (id) -(example: GET /nbi/api/v1/serviceSpecification/{uuid}) +(example: GET /nbi/api/v3/serviceSpecification/{uuid}) It is use to retrieve one serviceSpecification - all available information are retieved (see swagger for description) @@ -126,7 +127,7 @@ This API retrieves service(s) in the AAI inventory. Only following attributes wi GET Service Inventory (list): -(example: GET /nbi/api/v1/service/?relatedParty.id=Pontus +(example: GET /nbi/api/v3/service/?relatedParty.id=Pontus ) GET (by list) allows to request with following criteria (all optional) : @@ -145,7 +146,7 @@ if no service matches, an empty list is send back. GET Service Inventory (id): -(example: GET /nbi/api/v1/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) +(example: GET /nbi/api/v3/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) Because of AAI capability, additionally to the service id, customer id and [serviceSpecification.id or serviceSpecification.name] must be supplied. If the customer id is not supplied, External API will use ‘generic’ customer diff --git a/docs/offeredapis/pdf/nbicallflow.pdf b/docs/offeredapis/pdf/nbicallflow.pdf old mode 100755 new mode 100644 diff --git a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml index 96e8164..8483238 100644 --- a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml +++ b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml @@ -1,7 +1,3 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml enum LifecycleStatusValues { diff --git a/docs/offeredapis/serviceCatalog/asciiDoc.adoc b/docs/offeredapis/serviceCatalog/asciiDoc.adoc index c5185bd..9ce1396 100644 --- a/docs/offeredapis/serviceCatalog/asciiDoc.adoc +++ b/docs/offeredapis/serviceCatalog/asciiDoc.adoc @@ -1,9 +1,3 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// - = API ServiceCatalog @@ -12,10 +6,10 @@ Copyright 2018 Orange === Api URL -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/swagger.json[Swagger UI] +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/N3ma89X1x0/plantuml&noCache=797767.0[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[plant UML UI] serviceCatalog API designed for ONAP Beijing Release. This API is build from TMF open API17.5. @@ -24,13 +18,13 @@ Only operation GET (by id & byList) for resource serviceSpecification is ava === Version information [%hardbreaks] -__Version__ : 1.0.0_inProgress +__Version__ : 3.0.0_inProgress === URI scheme [%hardbreaks] __Host__ : serverRoot -__BasePath__ : /nbi/api/v1 +__BasePath__ : /nbi/api/v3 __Schemes__ : HTTPS @@ -39,11 +33,6 @@ __Schemes__ : HTTPS * ServiceSpecification -=== Consumes - -* `application/json;charset=utf-8` - - === Produces * `application/json;charset=utf-8` @@ -136,6 +125,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_servicespecificationget]] ==== Retrieve a service specification .... @@ -213,6 +207,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions diff --git a/docs/offeredapis/serviceCatalog/documentation.html b/docs/offeredapis/serviceCatalog/documentation.html index c81c1d8..94b011f 100644 --- a/docs/offeredapis/serviceCatalog/documentation.html +++ b/docs/offeredapis/serviceCatalog/documentation.html @@ -1,8 +1,3 @@ - @@ -442,7 +437,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • Version information
  • URI scheme
  • Tags
    • -
  • Consumes
  • Produces
    • @@ -474,6 +468,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Overview

    +

    Api URL

    +
    +

    Swagger UI

    +
    +
    +

    plant UML UI

    +

    serviceCatalog API designed for ONAP Beijing Release. This API is build from TMF open API17.5. @@ -483,14 +484,14 @@ Only operation GET (by id & byList) for resource serviceSpecification is ava

    Version information

    -

    Version : 1.0.0_inProgress

    +

    Version : 3.0.0_inProgress

    URI scheme

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

    @@ -505,16 +506,6 @@ Only operation GET (by id & byList) for resource serviceSpecification is ava
    -

    Consumes

    -
    -
      -
    • -

      application/json;charset=utf-8

      -
      • -
    -
    -
    -

    Produces

      @@ -680,6 +671,16 @@ Fields attribute could be used to filter attributes retrieved

    +
    +
    Produces
    +
    +
      +
    • +

      application/json;charset=utf-8

      +
      • +
    +
    +

    Retrieve a service specification

    @@ -821,6 +822,16 @@ Fields attribute could be used to filter attributes retrieved

    +
    +
    Produces
    +
    +
      +
    • +

      application/json;charset=utf-8

      +
      • +
    +
    +
    @@ -1471,7 +1482,7 @@ Please note that this attribute is managed in TMF - in future release we’l diff --git a/docs/offeredapis/serviceCatalog/markDown.md b/docs/offeredapis/serviceCatalog/markDown.md index 22d062e..7f1a02d 100644 --- a/docs/offeredapis/serviceCatalog/markDown.md +++ b/docs/offeredapis/serviceCatalog/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceCatalog @@ -10,10 +6,10 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/swagger.json) +[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/N3ma89X1x0/plantuml&noCache=797767.0) +[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. @@ -21,12 +17,12 @@ Only operation GET (by id & byList) for resource serviceSpecification is availab ### Version information -*Version* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*BasePath* : /nbi/api/v3 *Schemes* : HTTPS @@ -35,11 +31,6 @@ Only operation GET (by id & byList) for resource serviceSpecification is availab * ServiceSpecification -### Consumes - -* `application/json;charset=utf-8` - - ### Produces * `application/json;charset=utf-8` @@ -91,6 +82,11 @@ HTTP Response 422 Unprocessable entity |**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 ``` @@ -128,6 +124,11 @@ HTTP Response 422 Unprocessable entity |**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 diff --git a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml index a7ecc66..2c08be7 100644 --- a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml +++ b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml @@ -1,17 +1,5 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml -enum stateValues { - feasibilityChecked - designed - reserved - inactive - active - terminated -} class ErrorRepresentation { code:int @@ -28,12 +16,12 @@ class Service { href:string name:string type:string + state:string hasStarted:boolean @type:string @baseType:string @schemaLocation:string } - Service --> "0-1" stateValues : state Service --> "0-1" ServiceSpecificationRef : serviceSpecification Service --> "0-*" ServiceCharacteristic : characteristic Service --> "0-*" SupportingResource : supportingResource diff --git a/docs/offeredapis/serviceInventory/asciiDoc.adoc b/docs/offeredapis/serviceInventory/asciiDoc.adoc index 548a6a9..e34ec44 100644 --- a/docs/offeredapis/serviceInventory/asciiDoc.adoc +++ b/docs/offeredapis/serviceInventory/asciiDoc.adoc @@ -1,9 +1,3 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// - = API ServiceInventory @@ -12,10 +6,10 @@ Copyright 2018 Orange === Api URL -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/swagger.json[Swagger UI] +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/5an735gnX0/plantuml&noCache=304710.0[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[plant UML UI] serviceInventory API designed for ONAP Beijing Release. This API is build from TMF open API18.0 (applying TMF Guideline 3.0) @@ -24,13 +18,13 @@ only operation GET (by id & byList) for resource serviceSpecification is ava === Version information [%hardbreaks] -__Version__ : 1.0.0_inProgress +__Version__ : 3.0.0_inProgress === URI scheme [%hardbreaks] __Host__ : serverRoot -__BasePath__ : /nbi/api/v1 +__BasePath__ : /nbi/api/v3 __Schemes__ : HTTPS @@ -39,11 +33,6 @@ __Schemes__ : HTTPS * Service -=== Consumes - -* `application/json;charset=utf-8` - - === Produces * `application/json;charset=utf-8` @@ -140,6 +129,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceget]] ==== Retrieve a service .... @@ -222,6 +216,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions @@ -353,7 +352,7 @@ __optional__||< <<_relatedpartyref,RelatedPartyRef>> > array |**serviceSpecification** + __optional__||<<_servicespecificationref,ServiceSpecificationRef>> |**state** + -__optional__||<<_statevalues,stateValues>> +__optional__|State of the service. Not managed in Beijing release|string |**supportingResource** + __optional__||< <<_supportingresource,SupportingResource>> > array |**type** + @@ -460,8 +459,3 @@ __optional__|Not managed in Beijing release.|string __optional__|Not managed in Beijing release.|string |=== - -[[_statevalues]] -=== stateValues -__Type__ : enum (feasibilityChecked, designed, reserved, inactive, active, terminated) - diff --git a/docs/offeredapis/serviceInventory/documentation.html b/docs/offeredapis/serviceInventory/documentation.html index a55605a..f7fb115 100644 --- a/docs/offeredapis/serviceInventory/documentation.html +++ b/docs/offeredapis/serviceInventory/documentation.html @@ -1,8 +1,3 @@ - @@ -442,7 +437,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • Version information
  • URI scheme
  • Tags
    • -
  • Consumes
  • Produces
    • @@ -463,7 +457,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • ServiceSpecificationRef
  • SupportingResource
  • Value
    • -
  • stateValues
    • @@ -474,6 +467,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    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) @@ -483,14 +483,14 @@ only operation GET (by id & byList) for resource serviceSpecification is ava

    Version information

    -

    Version : 1.0.0_inProgress

    +

    Version : 3.0.0_inProgress

    URI scheme

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

    @@ -505,16 +505,6 @@ only operation GET (by id & byList) for resource serviceSpecification is ava
    -

    Consumes

    -
    -
      -
    • -

      application/json;charset=utf-8

      -
      • -
    -
    -
    -

    Produces

      @@ -687,6 +677,16 @@ fields attribute may be used to filter retrieved attribute(s) for each service
    +
    +
    Produces
    +
    +
      +
    • +

      application/json;charset=utf-8

      +
      • +
    +
    +

    Retrieve a service

    @@ -837,6 +837,16 @@ Attribute selection is enabled for all first level attributes.

    +
    +
    Produces
    +
    +
      +
    • +

      application/json;charset=utf-8

      +
      • +
    +
    +
    @@ -1156,8 +1166,8 @@ Not managed in Beijing release

    state
    optional

    - -

    stateValues

    +

    State of the service. Not managed in Beijing release

    +

    string

    supportingResource
    @@ -1410,18 +1420,12 @@ Not managed in Beijing release.

    -
    -

    stateValues

    -
    -

    Type : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)

    -
    -
    diff --git a/docs/offeredapis/serviceInventory/markDown.md b/docs/offeredapis/serviceInventory/markDown.md index 223c13b..c65263b 100644 --- a/docs/offeredapis/serviceInventory/markDown.md +++ b/docs/offeredapis/serviceInventory/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceInventory @@ -10,10 +6,10 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/swagger.json) +[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/5an735gnX0/plantuml&noCache=304710.0) +[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) @@ -21,12 +17,12 @@ only operation GET (by id & byList) for resource serviceSpecification is availab ### Version information -*Version* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*BasePath* : /nbi/api/v3 *Schemes* : HTTPS @@ -35,11 +31,6 @@ only operation GET (by id & byList) for resource serviceSpecification is availab * Service -### Consumes - -* `application/json;charset=utf-8` - - ### Produces * `application/json;charset=utf-8` @@ -93,6 +84,11 @@ HTTP Response 422 Unprocessable entity |**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 ``` @@ -133,6 +129,11 @@ HTTP Response 422 Unprocessable entity |**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 @@ -219,7 +220,7 @@ Instantiated service (service_instance) in AAI |**name**
    *optional*|Name of the service - Valued with service-instance-name|string| |**relatedParty**
    *optional*||< [RelatedPartyRef](#relatedpartyref) > array| |**serviceSpecification**
    *optional*||[ServiceSpecificationRef](#servicespecificationref)| -|**state**
    *optional*||[stateValues](#statevalues)| +|**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| @@ -284,8 +285,3 @@ Not managed in Beijing release. |**@type**
    *optional*|Not managed in Beijing release.|string| |**serviceCharacteristicValue**
    *optional*|Not managed in Beijing release.|string| - - -### stateValues -*Type* : enum (feasibilityChecked, designed, reserved, inactive, active, terminated) - diff --git a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml index eb78af2..775fdeb 100644 --- a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml +++ b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml @@ -1,7 +1,3 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml enum ActionType { @@ -24,6 +20,15 @@ enum StateType { enum RelationshipType { reliesOn } +enum EventType { + ServiceOrderCreationNotification + ServiceOrderStateChangeNotification + ServiceOrderItemStateChangeNotification +} +enum SeverityMessage { + information + error +} class ErrorRepresentation { code:int @@ -89,6 +94,7 @@ class OrderItemRelationship { class ServiceOrderItem { id:string + percentProgress:string @type:string @schemaLocation:string @baseType:string @@ -97,6 +103,7 @@ class ServiceOrderItem { ServiceOrderItem --> "0-1" StateType : state ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship ServiceOrderItem --> "1-1" Service : service + ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage class ServiceOrder { id:string @@ -119,6 +126,7 @@ class ServiceOrder { ServiceOrder --> "0-*" RelatedParty : relatedParty ServiceOrder --> "0-*" OrderRelationship : orderRelationship ServiceOrder --> "0-*" ServiceOrderItem : orderItem + ServiceOrder --> "0-*" OrderMessage : orderMessage class OrderRelationship { type:string @@ -169,4 +177,66 @@ class Hub { 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 index 29da92f..72ba736 100644 --- a/docs/offeredapis/serviceOrder/asciiDoc.adoc +++ b/docs/offeredapis/serviceOrder/asciiDoc.adoc @@ -1,56 +1,602 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// += 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>> +|=== -= API ServiceOrder +===== Responses -[[_overview]] -== Overview +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**400**|Bad Request -=== Api URL +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 -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json[Swagger UI] +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 -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/plantuml&noCache=934804.0[plant UML UI] +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity -serviceOrder API designed for ONAP Beijing Release. -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. +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable -=== Version information -[%hardbreaks] -__Version__ : 1.0.0_inProgress +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /nbi/api/v1 -__Schemes__ : HTTPS +===== Consumes +* `application/json;charset=utf-8` -=== Tags -* 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. +[[_notificationserviceorderstatechangenotification]] +==== Service order state change notification description +.... +POST /notification/serviceOrderStateChangeNotification +.... -=== Consumes +===== Description +Specific business errors for current operation will be encapsulated in -* `application/json;charset=utf-8` +HTTP Response 422 Unprocessable entity -=== Produces +===== Parameters -* `application/json;charset=utf-8` +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderstateChangeNotification** + +__required__|<<_serviceorderstatechangenotification,ServiceOrderStateChangeNotification>> +|=== -[[_paths]] -== Resources +===== 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 @@ -69,6 +615,11 @@ 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 @@ -103,7 +654,7 @@ __required__|<<_createserviceorder,CreateServiceOrder>> [options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema -|**201**|Success|<<_createserviceorder,CreateServiceOrder>> +|**201**|Success|<<_serviceorder,ServiceOrder>> |**400**|Bad Request List of supported error codes: @@ -164,6 +715,16 @@ List of supported error codes: |=== +===== Consumes + +* `application/json;charset=utf-8` + + +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceorderfind]] ==== List service orders .... @@ -258,6 +819,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceorderget]] ==== Retrieve a service order .... @@ -336,6 +902,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions @@ -347,6 +918,23 @@ 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. @@ -434,24 +1022,36 @@ __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,.^4"] +[options="header", cols=".^3,.^11,.^4"] |=== -|Name|Schema +|Name|Description|Schema |**callback** + -__required__|string +__required__|Address where notification must be send|string |**id** + -__optional__|string +__optional__|Hub Id|string |**query** + -__optional__|string +__required__||string |=== +[[_notification]] +=== Notification +Used to describe notification for this API + +__Type__ : object + + [[_orderitemrelationship]] === OrderItemRelationship Linked order item to the one containing this attribute. @@ -468,6 +1068,27 @@ __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. @@ -607,6 +1228,8 @@ __required__|ID created on repository side|string __optional__||string (date-time) |**orderItem** + __optional__||< <<_serviceorderitem,ServiceOrderItem>> > array +|**orderMessage** + +__optional__||< <<_ordermessage,OrderMessage>> > array |**orderRelationship** + __optional__||< <<_orderrelationship,OrderRelationship>> > array |**priority** + @@ -624,6 +1247,25 @@ __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. @@ -643,8 +1285,48 @@ not used in Beijing relase|string __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** + @@ -652,6 +1334,73 @@ __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 @@ -714,6 +1463,11 @@ Not used in Beijing release|string |=== +[[_severitymessage]] +=== SeverityMessage +__Type__ : enum (information, error) + + [[_statetype]] === StateType List of possible state for the order and the orderItem. diff --git a/docs/offeredapis/serviceOrder/documentation.html b/docs/offeredapis/serviceOrder/documentation.html index 09732b5..cab4964 100644 --- a/docs/offeredapis/serviceOrder/documentation.html +++ b/docs/offeredapis/serviceOrder/documentation.html @@ -1,8 +1,3 @@ - @@ -442,33 +437,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • Version information
  • URI scheme
  • Tags
    • -
  • Consumes
  • Produces
  • Resources
  • Definitions
    • ActionType
      • +
    • CreateHub
    • CreateServiceOrder
    • CreateServiceOrderItem
    • ErrorRepresentation
      • +
    • EventType
    • Hub
      • +
    • Notification
    • OrderItemRelationship
      • +
    • OrderMessage
    • OrderRelationship
    • RelatedParty
    • RelationshipType
    • Service
    • ServiceCharacteristic
    • ServiceOrder
      • +
    • ServiceOrderCreationNotification
    • ServiceOrderItem
      • +
    • ServiceOrderItemStateChangeNotification
      • +
    • ServiceOrderItemSummary
      • +
    • ServiceOrderStateChangeNotification
      • +
    • ServiceOrderSummary
      • +
    • ServiceOrderSummaryWithItem
    • ServiceRef
    • ServiceRelationship
    • ServiceSpecificationRef
      • +
    • SeverityMessage
    • StateType
    • TargetServiceSchema
    • Value
      • @@ -482,8 +489,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

      Overview

      +

      Api URL

      -

      serviceOrder API designed for ONAP Beijing Release. +

      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.

      @@ -491,14 +505,14 @@ Only operations GET (by id and list) and POST are available.

      Version information

      -

      Version : 1.0.0_inProgress

      +

      Version : 3.0.0_inProgress

      URI scheme

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

      @@ -507,17 +521,13 @@ Only operations GET (by id and list) and POST are available.

      • -

        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.

        +

        Hub

        • -
      -
      -
      -
      -

      Consumes

      -
      -
      • -

        application/json;charset=utf-8

        +

        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.

      @@ -538,55 +548,22 @@ Only operations GET (by id and list) and POST are available.

      Resources

      -

      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.

      -
      +

      Hub

      -

      Create a service order

      +

      Create Hub

      -
      POST /serviceOrder
      +
      POST /hub
      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.

      -
      -

      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
      @@ -606,9 +583,9 @@ POST should be used without specifying the id and the href, the Service Order Ma

      Body

      -

      serviceOrder
      +

      Hub
      required

      -

      CreateServiceOrder

      +

      CreateHub

      @@ -631,8 +608,10 @@ POST should be used without specifying the id and the href, the Service Order Ma

      201

      -

      Success

      -

      CreateServiceOrder

      +

      Success
      +Headers :
      +location (string)

      +

      file

      400

      @@ -678,15 +657,7 @@ POST should be used without specifying the id and the href, the Service Order Ma

      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

      +

      Functional error

      ErrorRepresentation

      @@ -707,22 +678,27 @@ POST should be used without specifying the id and the href, the Service Order Ma
      +
      +
      Consumes
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      -

      List service orders

      +

      Retrieve a lits of hub

      -
      GET /serviceOrder
      +
      GET /hub
      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

      @@ -733,74 +709,28 @@ Attribute selection could be described in the fields attribute.

      Parameters
      ----+++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - @@ -824,11 +754,8 @@ Attribute selection could be described in the fields attribute.

      - - + + @@ -895,19 +822,28 @@ Attribute selection could be described in the fields attribute.

      Type NameDescription 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
      +

      eventType
      optional

      order date lower than

      string

      enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

      Query

      state
      +

      id
      optional

      state of the order(s) to be retrieved

      string

      200

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

      < ServiceOrder > array

      Success

      < Hub > array

      400
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      -

      Retrieve a service order

      +

      Retrieve an HUB by id

      -
      GET /serviceOrder/{id}
      +
      GET /hub/{hubId}
      Description
      -

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

      +

      Retrieve an HUB by id

      Specific business errors for current operation will be encapsulated in

      @@ -920,32 +856,22 @@ Attribute selection is enabled for all first level attributes.

      Parameters
      ----+++ - - - - - - - - - @@ -970,7 +896,7 @@ Attribute selection is enabled for all first level attributes.

      - + @@ -1037,123 +963,1538 @@ Attribute selection is enabled for all first level attributes.

      Type NameDescription Schema

      Path

      id
      +

      hubId
      required

      string

      Query

      fields
      -optional

      Attribute selection

      string

      200

      Success

      ServiceOrder

      Hub

      400
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +

      delete hub

      +
      +
      +
      DELETE /hub/{hubId}
      -
      -

      Definitions

      -
      -
      -

      ActionType

      -
      -

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

      +
      +
      Description
      -

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

      -
      +

      Specific business errors for current operation will be encapsulated in

      -
      -

      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.

      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      Parameters
      ---+++ + - - - - - - - - - - - - - + + + +
      Type NameDescription Schema

      @baseType
      -optional

      string

      @schemaLocation
      -optional

      string

      @type
      -optional

      Path

      hubId
      +required

      string
      +
      +
      +
      Responses
      + +++++ + - - - + + + + + - - - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      category
      -optional

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

      string

      		HTTP CodeDescriptionSchema

      description
      -optional

      A free-text description of the service order

      string

      204

      Success

      No Content

      externalId
      +

      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
      +

      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

      < CreateServiceOrderItem > array

      < OrderItemRelationship > array

      orderRelationship
      -optional

      service
      +required

      < OrderRelationship > array

      Service
      +
      +
      +

      ErrorRepresentation

      +
      +

      Representation of an error.

      +
      + +++++ + - + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      priority
      +

      		NameDescriptionSchema

      @schemaLocation
      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)

      it provides a link to the schema describing a REST resource

      string

      relatedParty
      +

      @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

      < RelatedParty > array

      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

      requestedCompletionDate
      +

      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

      Requested delivery date from the requestor perspective

      string (date-time)

      A code associated to this message

      string

      requestedStartDate
      +

      correctionRequired
      +required

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

      boolean

      field
      optional

      Order start date wished by the requestor

      string (date-time)

      Service Order attribute related to this error message

      string

      messageInformation
      +optional

      Message related to this order

      string

      severity
      +required

      SeverityMessage
      -

      CreateServiceOrderItem

      +

      OrderRelationship

      -

      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.

      +

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

      @@ -1170,54 +2511,103 @@ Attribute description is not accurate and should be find in the serviceOrderItem - - + - - + - + + + + + - + + + + +

      @baseType
      +

      @referredType
      optional

      Indicates the base type of the resource.

      Type of the referred order.

      string

      @schemaLocation
      +

      href
      optional

      A link to the schema describing this REST resource

      A hyperlink to the related order

      string

      @type
      +

      id
      +required

      The id of the related order

      string

      type
      optional

      Indicates the type of resource.

      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

      action
      +

      href
      optional

      ActionType

      An hyperlink to the party - not used in Beijnig release

      string

      id
      required

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

      Unique identifier of a related party

      string

      orderItemRelationship
      +

      name
      optional

      < OrderItemRelationship > array

      Name of the related party

      string

      service
      +

      role
      required

      Service

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

      string
      -

      ErrorRepresentation

      +

      RelationshipType

      -

      Representation of an error.

      +

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

      +
      +
      +

      Type : enum (reliesOn)

      +
      +
      +
      +

      Service

      +
      +

      Service (to be added, modified, deleted) description

      @@ -1236,89 +2626,75 @@ Attribute description is not accurate and should be find in the serviceOrderItem - + - + - - - - - - - + - - + - - + - - - + + - -

      @schemaLocation
      optional

      it provides a link to the schema describing a REST resource

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

      string

      @type
      optional

      The class type of a REST resource

      To define the service type +Not managed in Beijing Release

      string

      code
      -required

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

      integer (int32)

      message
      +

      href
      optional

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

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

      string

      reason
      +

      id
      required

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

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

      string

      referenceError
      +

      name
      optional

      url pointing to documentation describing the error

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

      string

      status
      +

      relatedParty
      optional

      http error code extension like 400-2

      string

      < RelatedParty > array
      -
      -
      -

      Hub

      -
      -

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

      -
      - ---- - - - + + + - - - - + + + - - + + - +
      NameSchema

      serviceCharacteristic
      +optional

      < ServiceCharacteristic > array

      callback
      -required

      string

      serviceRelationship
      +optional

      < ServiceRelationship > array

      id
      +

      serviceSpecification
      optional

      string

      ServiceSpecificationRef

      query
      +

      serviceState
      optional

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

      string
      -

      OrderItemRelationship

      +

      ServiceCharacteristic

      -

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

      +

      ServiceCharacteristic

      @@ -1335,25 +2711,30 @@ nbi component used this relationship to sort request to ONAP.

      - - + - + - + + + + + +

      id
      +

      name
      required

      Unique identifier of an order item

      Name of characteristic

      string

      type
      -required

      value
      +optional

      RelationshipType

      Value

      valueType
      +optional

      string
      -

      OrderRelationship

      +

      ServiceOrder

      -

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

      +

      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

      @@ -1370,40 +2751,132 @@ This relationship is not used to sort ONAP request.

      - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      @referredType
      +

      @baseType
      optional

      Type of the referred order.

      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

      A hyperlink to the related order

      Hyperlink to access the order

      string

      id
      required

      The id of the related order

      ID created on repository side

      string

      type
      +

      orderDate
      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 (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
      -

      RelatedParty

      +

      ServiceOrderCreationNotification

      -

      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.

      +

      Notification structure for a service order creation notification

      @@ -1420,53 +2893,36 @@ o If no relatedParty are provided the service will be affected to ‘generic’ - + - - - - - - + - - - + + - - + + - - +

      @referredType
      -optional

      event
      +required

      string

      href
      -optional

      An hyperlink to the party - not used in Beijnig release

      string

      ServiceOrderSummary

      id
      +

      eventDate
      required

      Unique identifier of a related party

      string

      string (date-time)

      name
      -optional

      Name of the related party

      eventId
      +required

      string

      role
      +

      eventType
      required

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

      Default : "ServiceOrderCreationNotification"

      string
      -

      RelationshipType

      -
      -

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

      -
      -
      -

      Type : enum (reliesOn)

      -
      -
      -
      -

      Service

      +

      ServiceOrderItem

      -

      Service (to be added, modified, deleted) description

      +

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

      @@ -1483,77 +2939,116 @@ Only reliesOn is managed in Beijing release.

      + + + + + - + - + - - - + + - + - - - + + - - + - + + + + + - + - - + + +

      @baseType
      +optional

      not used in Beijing relase

      string

      @schemaLocation
      optional

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

      not used in Beijing relase

      string

      @type
      optional

      To define the service type -Not managed in Beijing Release

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

      string

      href
      +

      action
      optional

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

      string

      ActionType

      id
      required

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

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

      string

      name
      +

      orderItemMessage
      optional

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

      string

      < OrderMessage > array

      relatedParty
      +

      orderItemRelationship
      optional

      < RelatedParty > array

      < OrderItemRelationship > array

      serviceCharacteristic
      +

      percentProgress
      optional

      Progress of the delivery in percentage.

      string

      service
      +required

      < ServiceCharacteristic > array

      Service

      serviceRelationship
      +

      state
      optional

      < ServiceRelationship > array

      StateType
      +
      +
      +

      ServiceOrderItemStateChangeNotification

      + +++++ + - + + + + + + + + - + - - + + + + + + + + + + + +

      serviceSpecification
      -optional

      		NameDescriptionSchema

      event
      +required

      ServiceSpecificationRef

      ServiceOrderSummaryWithItem

      serviceState
      -optional

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

      eventDate
      +required

      string (date-time)

      eventId
      +required

      string

      eventType
      +required

      Default : "ServiceOrderStateChangeNotification"

      string
      -

      ServiceCharacteristic

      +

      ServiceOrderItemSummary

      -

      ServiceCharacteristic

      +

      Service Order item summary to be used for notification

      @@ -1570,30 +3065,36 @@ Not managed in Beijing release.

      - + + + + + - + - + - + - - +

      name
      +

      action
      +optional

      ActionType

      id
      required

      Name of characteristic

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

      string

      value
      -optional

      service
      +required

      Value

      Service

      valueType
      +

      state
      optional

      string

      StateType
      -

      ServiceOrder

      +

      ServiceOrderStateChangeNotification

      -

      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

      +

      Service order state change notification description

      @@ -1610,45 +3111,55 @@ Not managed in Beijing release.

      - + - + - + - + - + - - + + + +

      @baseType
      -optional

      event
      +required

      string

      ServiceOrderSummary

      @schemaLocation
      -optional

      eventDate
      +required

      string

      string (date-time)

      @type
      -optional

      eventId
      +required

      string

      category
      -optional

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

      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

      +
      + +++++ + - - - - - - - - + + + + + - - + @@ -1676,48 +3187,6 @@ Not managed in Beijing release.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1727,9 +3196,9 @@ Not managed in Beijing release.

      completionDateTime
      -optional

      Date when the order was completed

      string (date-time)

      description
      -optional

      A free-text description of the service order

      string

      		NameDescriptionSchema

      expectedCompletionDate
      +

      completionDateTime
      optional

      Date when the order was completed

      string (date-time)

      string (date-time)

      orderItem
      -optional

      < ServiceOrderItem > 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
      -

      ServiceOrderItem

      +

      ServiceOrderSummaryWithItem

      -

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

      +

      Service order item summary with item description

      @@ -1746,47 +3215,40 @@ Not managed in Beijing release.

      - - - + + - - + - - + - - - - - - + - - + - + - +

      @baseType
      +

      completionDateTime
      optional

      not used in Beijing relase

      string

      Date when the order was completed

      string (date-time)

      @schemaLocation
      +

      externalId
      optional

      not used in Beijing relase

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

      string

      @type
      +

      href
      optional

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

      Hyperlink to access the order

      string

      action
      -optional

      ActionType

      id
      required

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

      ID created on repository side

      string

      orderItemRelationship
      +

      orderDate
      optional

      < OrderItemRelationship > array

      string (date-time)

      service
      -required

      orderItem
      +optional

      Service

      < ServiceOrderItemSummary > array

      state
      @@ -1937,6 +3399,12 @@ Not used in Beijing release
      +

      SeverityMessage

      +
      +

      Type : enum (information, error)

      +
      +
      +

      StateType

      List of possible state for the order and the orderItem.

      @@ -2028,7 +3496,7 @@ This attribute must be used in Beijing Release to provide characteristic value.<
      diff --git a/docs/offeredapis/serviceOrder/markDown.md b/docs/offeredapis/serviceOrder/markDown.md index b47779b..0c11b20 100644 --- a/docs/offeredapis/serviceOrder/markDown.md +++ b/docs/offeredapis/serviceOrder/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceOrder @@ -10,43 +6,319 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json) +[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/kl1kgvz1zR/plantuml&noCache=934804.0) +[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 Beijing Release. +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* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*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. -### Consumes +### Produces * `application/json;charset=utf-8` -### Produces + +## 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` - -## Resources + +#### 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 @@ -65,6 +337,11 @@ 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 @@ -95,7 +372,7 @@ HTTP Response 422 Unprocessable entity |HTTP Code|Description|Schema| |---|---|---| -|**201**|Success|[CreateServiceOrder](#createserviceorder)| +|**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)| @@ -105,6 +382,16 @@ HTTP Response 422 Unprocessable entity |**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 ``` @@ -150,6 +437,11 @@ HTTP Response 422 Unprocessable entity |**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 ``` @@ -188,6 +480,11 @@ HTTP Response 422 Unprocessable entity |**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 @@ -199,6 +496,17 @@ 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. @@ -254,17 +562,29 @@ Representation of an error. |**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|Schema| -|---|---| -|**callback**
      *required*|string| -|**id**
      *optional*|string| -|**query**
      *optional*|string| +|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 @@ -279,6 +599,20 @@ nbi component used this relationship to sort request to ONAP. |**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. @@ -369,6 +703,7 @@ A Service Order is a type of order which can be used to place an order between a |**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| @@ -378,6 +713,19 @@ A Service Order is a type of order which can be used to place an order between a |**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. @@ -390,11 +738,81 @@ An identified part of the order. A service order is decomposed into one or more |**@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 @@ -435,6 +853,11 @@ The service specification (these attributes are fetched from the catalogue). |**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. diff --git a/docs/offeredapis/swaggers/listener-1_0_0.json b/docs/offeredapis/swaggers/listener-1_0_0.json new file mode 100644 index 0000000..7aa65fb --- /dev/null +++ b/docs/offeredapis/swaggers/listener-1_0_0.json @@ -0,0 +1,210 @@ + +{ + "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 new file mode 100644 index 0000000..390abe0 --- /dev/null +++ b/docs/offeredapis/swaggers/listener-1_0_0.yaml @@ -0,0 +1,142 @@ +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 new file mode 100644 index 0000000..aedd4a5 --- /dev/null +++ b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json @@ -0,0 +1,660 @@ + +{ + "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 new file mode 100644 index 0000000..50ae7cf --- /dev/null +++ b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml @@ -0,0 +1,493 @@ +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 new file mode 100644 index 0000000..3a5bfc1 --- /dev/null +++ b/docs/offeredapis/swaggers/serviceInventory_3_0_0.json @@ -0,0 +1,614 @@ + +{ + "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 new file mode 100644 index 0000000..dd1097f --- /dev/null +++ b/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml @@ -0,0 +1,419 @@ +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 new file mode 100644 index 0000000..47a0113 --- /dev/null +++ b/docs/offeredapis/swaggers/serviceOrder_3_0_0.json @@ -0,0 +1,2062 @@ + +{ + "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 new file mode 100644 index 0000000..db0479f --- /dev/null +++ b/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml @@ -0,0 +1,1428 @@ +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" diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst new file mode 100755 index 0000000..1551e3a --- /dev/null +++ b/docs/releasenotes/releasenotes.rst @@ -0,0 +1,122 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 ORANGE + +Release Notes +============= + +Version: 3.0.0 +-------------- + +:Release Date: 2018-11-15 + +**New Features** + +Main features are: + +- `EXTAPI-96 `_ - Add notification for serviceOrder API +- `EXTAPI-97 `_ - Upgrade ServiceOrder API to manage modification UC +- `EXTAPI-100 `_ - Improve ServiceInventory API +- `EXTAPI-101 `_ - Integrate ExtAPI/NBI to MSB +- `EXTAPI-102 `_ - Integrate ExtAPI/NBI to an E2E ONAP UC +- `EXTAPI-116 `_ - Help NBI user to get information when Service order fails +- `EXTAPI-125 `_ - Hadd support for progress percentage on ServiceOrder tracking + +Detail of features described in the readTheDoc documentation. + +**Bug Fixes** + +- `EXTAPI-70 `_ - NBI should add relationship to tenant when creating service-subscription in AAI + + +**Known Issues** + +No new issue (see Beijing ones) + +**Security Notes** + +To be completed + +Quick Links: + +- `External API project page `_ +- `Passing Badge information for External API `_ +- `Project Vulnerability Review Table for External API `_ + +**Upgrade Notes** + +To be completed + +**Deprecation Notes** + +No deprecated feature from Beijing. + +**Other** + +=========== + +Version: 1.0.0 +-------------- + +:Release Date: 2018-06-07 + +**New Features** + +Main features are: + +- `EXTAPI-39 `_ - Retrieve SDC information (catalog information) for service level artifacts based on TMF633 open APIs - operation GET +- `EXTAPI-41 `_ - Retrieve AAI information (inventory information) for service instance level artifacts based on TMF638 open APIs - operation GET +- `EXTAPI-42 `_ - Create and retrieve SO service request for service level based on TMF641 open APIS - Operations POST & GET + +Detail of features described in the readTheDoc documentation. + +**Bug Fixes** + +Not applicable - This is an initial release + +**Known Issues** + +For service catalog: + +- Find criteria are limited + +For service inventory: + +- Customer information must be passed to get complete service representation. +- Find criteria are limited. + +For service order: + +- ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change). +- Only service level request is performed. +- No request for VNF/VF and no call to SDNC. +- `EXTAPI-70 `_ : links between customer/service instance and cloud/tenant not done (trigger VID issue). +- Only active service state is considered to add a service. + +Detail of limitations described in the readTheDoc documentation. + +**Security Notes** + +External API code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The External API open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. +Authentication management and Data Access rights have not been implemented. + +Quick Links: + +- `External API project page `_ +- `Passing Badge information for External API `_ +- `Project Vulnerability Review Table for External API `_ + +**Upgrade Notes** + +Not applicable - This is an initial release + +**Deprecation Notes** + +Not applicable - This is an initial release + +**Other** + +=========== + +End of Release Notes diff --git a/restclient/.vscode/settings.json b/restclient/.vscode/settings.json index 1753f9a..2238a71 100644 --- a/restclient/.vscode/settings.json +++ b/restclient/.vscode/settings.json @@ -6,7 +6,7 @@ "rest-client.fontSize":12, "rest-client.environmentVariables": { "ONAP external api nbi local": { - "serviceOrder.url": "http://localhost:8080/nbi/api/v1" + "serviceOrder.url": "http://localhost:8080/nbi/api/v3" } } } \ No newline at end of file diff --git a/src/main/java/org/onap/nbi/ServiceRegisterRunner.java b/src/main/java/org/onap/nbi/ServiceRegisterRunner.java index a30be98..5e0c711 100644 --- a/src/main/java/org/onap/nbi/ServiceRegisterRunner.java +++ b/src/main/java/org/onap/nbi/ServiceRegisterRunner.java @@ -49,16 +49,16 @@ public class ServiceRegisterRunner implements CommandLineRunner { @Value("${msb.service.host}") private String SERVICE_HOST; - @Value("${msb.service.port}") + @Value("${server.port}") private String SERVICE_PORT; @Value("${msb.service.name}") private String SERVICE_NAME; - @Value("${msb.service.version}") + @Value("${nbi.version}") private String SERVICE_VERSION; - @Value("${msb.service.url}") + @Value("${server.contextPath}") private String SERVICE_URL; @Value("${msb.service.custom_path}") diff --git a/src/main/java/org/onap/nbi/apis/status/StatusResource.java b/src/main/java/org/onap/nbi/apis/status/StatusResource.java index 96332ec..4fead09 100644 --- a/src/main/java/org/onap/nbi/apis/status/StatusResource.java +++ b/src/main/java/org/onap/nbi/apis/status/StatusResource.java @@ -20,6 +20,7 @@ import org.onap.nbi.apis.status.model.StatusType; import org.onap.nbi.commons.JsonRepresentation; import org.onap.nbi.commons.ResourceManagement; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @@ -36,8 +37,11 @@ public class StatusResource extends ResourceManagement { @Autowired private StatusService statusService; + @Value("${nbi.version}") + private String version; + private JsonRepresentation fullRepresentation = new JsonRepresentation().add("name").add("status").add("version") - .add("components.name").add("components.status"); + .add("components.name").add("components.status"); @GetMapping(value = "", produces = MediaType.APPLICATION_JSON_VALUE) public ResponseEntity status(HttpServletRequest request) { @@ -47,13 +51,12 @@ public class StatusResource extends ResourceManagement { final String[] splitPath = request.getRequestURI().split("/"); final String applicationName = splitPath[1]; - final String applicationVersion = splitPath[3]; - final ApplicationStatus applicationStatus = this.statusService.get(applicationName, applicationVersion); + final ApplicationStatus applicationStatus = this.statusService.get(applicationName, version); final boolean isServiceFullyFunctional = - StatusType.OK.equals(applicationStatus.getStatus()) ? applicationStatus.getComponents().stream() - .allMatch(componentStatus -> StatusType.OK.equals(componentStatus.getStatus())) : false; + StatusType.OK.equals(applicationStatus.getStatus()) ? applicationStatus.getComponents().stream() + .allMatch(componentStatus -> StatusType.OK.equals(componentStatus.getStatus())) : false; // filter object Object response = this.getEntity(applicationStatus, fullRepresentation); diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 347d855..c6289fa 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -14,8 +14,10 @@ # limitations under the License. # +nbi.version=v3 + # SERVER -server.contextPath=/nbi/api/v3 +server.contextPath=/nbi/api/${nbi.version} server.port=8080 # LOGGING @@ -27,7 +29,7 @@ onap.tenantId=6e97a2bd51d74f6db5671d8dc1517d82 onap.cloudOwner=CloudOwner # NBI -nbi.url=http://localhost:8080/nbi/api/v3 +nbi.url=http://localhost:${server.port}${server.contextPath} nbi.callForVNF=false # SCHEDULER @@ -57,10 +59,7 @@ msb.enabled=true msb.discovery.host=msb_discovery msb.discovery.port=10081 msb.service.host= -msb.service.port=${server.port} msb.service.name=nbi -msb.service.version=v1 -msb.service.url=${server.contextPath} msb.service.custom_path= msb.service.protocol=REST msb.service.visual_range=1 diff --git a/src/test/java/org/onap/nbi/apis/StatusResourceTest.java b/src/test/java/org/onap/nbi/apis/StatusResourceTest.java index d9309be..9b80745 100644 --- a/src/test/java/org/onap/nbi/apis/StatusResourceTest.java +++ b/src/test/java/org/onap/nbi/apis/StatusResourceTest.java @@ -22,6 +22,7 @@ import org.junit.Test; import org.junit.runner.RunWith; import org.onap.nbi.apis.status.StatusResource; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; @@ -37,12 +38,18 @@ public class StatusResourceTest { @Autowired StatusResource statusResource; + @Value("${server.contextPath}") + String contextPath; + + @Value("${nbi.version}") + String version; + private MockHttpServletRequest request; @Before public void setup() { request = new MockHttpServletRequest(); - request.setRequestURI("/nbi/api/v1/status"); + request.setRequestURI(contextPath); } @Test @@ -52,6 +59,6 @@ public class StatusResourceTest { ObjectNode status = (ObjectNode) response.getBody(); assertThat(status.get("name").textValue()).isEqualTo("nbi"); assertThat(status.get("status").toString()).isEqualTo("OK"); - assertThat(status.get("version").textValue()).isEqualTo("v1"); + assertThat(status.get("version").textValue()).isEqualTo(version); } } diff --git a/src/test/resources/application.properties b/src/test/resources/application.properties index b214f9a..2dc0a70 100644 --- a/src/test/resources/application.properties +++ b/src/test/resources/application.properties @@ -14,8 +14,10 @@ # limitations under the License. # +nbi.version=v3 + # SERVER -server.contextPath=/nbi/api/v3 +server.contextPath=/nbi/api/${nbi.version} server.port = 8080 # LOGGING @@ -27,7 +29,7 @@ onap.tenantId=31047205ce114b60833b23e400d6a535 onap.cloudOwner=CloudOwner # NBI -nbi.url=http://127.0.0.1:8080/nbi/api/v3 +nbi.url=http://localhost:${server.port}${server.contextPath} nbi.callForVNF=false # SCHEDULER @@ -57,10 +59,7 @@ msb.enabled=false msb.discovery.host=msb_discovery msb.discovery.port=10081 msb.service.host= -msb.service.port=${server.port} msb.service.name=nbi -msb.service.version=v1 -msb.service.url=${server.contextPath} msb.service.custom_path= msb.service.protocol=REST msb.service.visual_range=1 -- 2.16.6