From c371fc9d8dd18b9cbdefeb4f2c48b67b99acde20 Mon Sep 17 00:00:00 2001 From: Rene Robert Date: Fri, 20 Apr 2018 13:12:45 +0000 Subject: nbi doc update Issue-ID: EXTAPI-74 Change-Id: Iedf3bad3ac690a3e2e2ffbb77bff6bc5aee20323 Signed-off-by: Rene Robert --- docs/offeredapis/index.rst | 14 +++++----- docs/offeredapis/pdf/nbicallflow.pdf | Bin 0 -> 586171 bytes ...PBeijingServiceOrderDoc.postman_collection.json | 31 +++++++++++++++++++-- .../serviceCatalog/apiServiceCatalog.plantuml | 4 --- docs/offeredapis/serviceCatalog/asciiDoc.adoc | 6 ---- docs/offeredapis/serviceCatalog/documentation.html | 5 ---- docs/offeredapis/serviceCatalog/markDown.md | 4 --- .../serviceInventory/apiServiceInventory.plantuml | 4 --- docs/offeredapis/serviceInventory/asciiDoc.adoc | 6 ---- .../serviceInventory/documentation.html | 5 ---- docs/offeredapis/serviceInventory/markDown.md | 4 --- .../serviceOrder/apiServiceOrder.plantuml | 4 --- docs/offeredapis/serviceOrder/asciiDoc.adoc | 6 ---- docs/offeredapis/serviceOrder/documentation.html | 5 ---- docs/offeredapis/serviceOrder/markDown.md | 4 --- .../offeredapis/swaggers/serviceCatalog_1_0_0.yaml | 4 --- .../swaggers/serviceInventory_1_0_0.yaml | 4 --- docs/offeredapis/swaggers/serviceOrder_1_0_0.json | 2 +- docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml | 6 +--- 19 files changed, 37 insertions(+), 81 deletions(-) create mode 100644 docs/offeredapis/pdf/nbicallflow.pdf (limited to 'docs/offeredapis') diff --git a/docs/offeredapis/index.rst b/docs/offeredapis/index.rst index 47cae40..bbc8c8d 100644 --- a/docs/offeredapis/index.rst +++ b/docs/offeredapis/index.rst @@ -10,9 +10,7 @@ nbi - northbound interface - External API for ONAP Introduction *************** -NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be used by external systems as BSS for example. -These API are based on **TMF API**. - +NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be used by external systems as BSS for example. These API are based on **TMF API**. *************** Global NBI architecture for Beijing release @@ -75,9 +73,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 `", "`link `_", "coming", "coming" - "serviceInventory", ":download:`link `", ":download:`link `", ":download:`link `", "`link `_", "coming", "coming" - "serviceOrder", ":download:`link `", ":download:`link `", ":download:`link `", "`link `_", ":download:`link `", "coming" + "serviceCatalog", ":download:`link `", ":download:`link `", ":download:`link `", "`link `_", "coming", "coming" + "serviceInventory", ":download:`link `", ":download:`link `", ":download:`link `", "`link `_", "coming", "coming" + "serviceOrder", ":download:`link `", ":download:`link `", ":download:`link `", "`link `_", ":download:`link `", "coming" *************** @@ -193,5 +191,7 @@ With the current version of APIs used from SO and AAI we need to manage a ‘cus Developer Guide *************** -Technical information about NBI (dependancies, configuration, running & testing) could be found here: :doc:`DevDoc <../architecture/NBI_R1_Developer_Guide>` +Technical information about NBI (dependancies, configuration, running & testing) could be found here: :doc:`NBI_R1_Developer_Guide <../architecture/NBI_R1_Developer_Guide>` + +API Flow illustration (with example messages) is described in this document: :download:`nbicallflow.pdf ` diff --git a/docs/offeredapis/pdf/nbicallflow.pdf b/docs/offeredapis/pdf/nbicallflow.pdf new file mode 100644 index 0000000..0763c55 Binary files /dev/null and b/docs/offeredapis/pdf/nbicallflow.pdf differ diff --git a/docs/offeredapis/postman/ONAPBeijingServiceOrderDoc.postman_collection.json b/docs/offeredapis/postman/ONAPBeijingServiceOrderDoc.postman_collection.json index 92a16eb..832a9e4 100644 --- a/docs/offeredapis/postman/ONAPBeijingServiceOrderDoc.postman_collection.json +++ b/docs/offeredapis/postman/ONAPBeijingServiceOrderDoc.postman_collection.json @@ -1,8 +1,8 @@ { "variables": [], "info": { - "name": "ONAP Beijing ServiceOrder Doc", - "_postman_id": "d88ad75d-6fae-13ea-d63c-cac1f445a1bf", + "name": "ONAP Beijing ServiceOrder Test", + "_postman_id": "3e51270b-0ef8-0bc3-5b92-8c9b8270cb71", "description": "", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, @@ -10,7 +10,7 @@ { "name": "ServiceOrder1", "request": { - "url": "{nbiHostName}:{nbiPort}/nbi/api/v1/serviceOrder", + "url": "http://127.0.0.1:8090/serviceOrder", "method": "POST", "header": [ { @@ -56,6 +56,31 @@ "description": "" }, "response": [] + }, + { + "name": "ServiceOrder3", + "request": { + "url": "http://127.0.0.1:8090/serviceOrder", + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "" + }, + { + "key": "Content-Type", + "value": "application/json", + "description": "" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"externalId\": \"LudONAP002\",\n \"priority\": \"1\",\n \"description\": \"Ludo ONAP Order\",\n \"category\": \"Consumer\",\n \"requestedStartDate\": \"2018-02-28T13:33:37.299Z\",\n \"requestedCompletionDate\": \"2018-02-28T13:33:37.299Z\",\n \"orderItem\": [\n {\n \"id\": \"1\",\n \"action\": \"add\",\n \"service\": {\n \"id\": \"vFW0002\",\n \"serviceState\": \"active\",\n \"serviceSpecification\": {\n \"id\": \"3dd3923d-1681-4f5b-99bb-f695ab147004\"\n }\n }\n }\n ]\n}" + }, + "description": "" + }, + "response": [] } ] } \ No newline at end of file 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..327f239 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 diff --git a/docs/offeredapis/serviceCatalog/documentation.html b/docs/offeredapis/serviceCatalog/documentation.html index c81c1d8..b1ea44a 100644 --- a/docs/offeredapis/serviceCatalog/documentation.html +++ b/docs/offeredapis/serviceCatalog/documentation.html @@ -1,8 +1,3 @@ - diff --git a/docs/offeredapis/serviceCatalog/markDown.md b/docs/offeredapis/serviceCatalog/markDown.md index 22d062e..4d066c3 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 diff --git a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml index a7ecc66..447f3fe 100644 --- a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml +++ b/docs/offeredapis/serviceInventory/apiServiceInventory.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 stateValues { diff --git a/docs/offeredapis/serviceInventory/asciiDoc.adoc b/docs/offeredapis/serviceInventory/asciiDoc.adoc index 548a6a9..c6f51c4 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 diff --git a/docs/offeredapis/serviceInventory/documentation.html b/docs/offeredapis/serviceInventory/documentation.html index a55605a..905fa1b 100644 --- a/docs/offeredapis/serviceInventory/documentation.html +++ b/docs/offeredapis/serviceInventory/documentation.html @@ -1,8 +1,3 @@ - diff --git a/docs/offeredapis/serviceInventory/markDown.md b/docs/offeredapis/serviceInventory/markDown.md index 223c13b..3b02751 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 diff --git a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml index eb78af2..3199855 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 { diff --git a/docs/offeredapis/serviceOrder/asciiDoc.adoc b/docs/offeredapis/serviceOrder/asciiDoc.adoc index 29da92f..4a29548 100644 --- a/docs/offeredapis/serviceOrder/asciiDoc.adoc +++ b/docs/offeredapis/serviceOrder/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 ServiceOrder diff --git a/docs/offeredapis/serviceOrder/documentation.html b/docs/offeredapis/serviceOrder/documentation.html index 09732b5..0983ed9 100644 --- a/docs/offeredapis/serviceOrder/documentation.html +++ b/docs/offeredapis/serviceOrder/documentation.html @@ -1,8 +1,3 @@ - diff --git a/docs/offeredapis/serviceOrder/markDown.md b/docs/offeredapis/serviceOrder/markDown.md index b47779b..5ee40cf 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 diff --git a/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml b/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml index ab6eaa9..95e62fa 100644 --- a/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml +++ b/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml @@ -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 - swagger: "2.0" info: description: "serviceCatalog API designed for ONAP Beijing Release.\nThis API is\ diff --git a/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml b/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml index c4a169e..99af226 100644 --- a/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml +++ b/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml @@ -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 - swagger: "2.0" info: description: "serviceInventory API designed for ONAP Beijing Release.\nThis API\ diff --git a/docs/offeredapis/swaggers/serviceOrder_1_0_0.json b/docs/offeredapis/swaggers/serviceOrder_1_0_0.json index 9df30a3..b2ffb2c 100644 --- a/docs/offeredapis/swaggers/serviceOrder_1_0_0.json +++ b/docs/offeredapis/swaggers/serviceOrder_1_0_0.json @@ -56,7 +56,7 @@ "201": { "description": "Success", "schema": { - "$ref": "#/definitions/CreateServiceOrder" + "$ref": "#/definitions/ServiceOrder" } }, diff --git a/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml b/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml index edb5089..fa2c28e 100644 --- a/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml +++ b/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml @@ -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 - swagger: "2.0" info: description: "serviceOrder API designed for ONAP Beijing Release.\nThis API is build\ @@ -63,7 +59,7 @@ paths: 201: description: "Success" schema: - $ref: "#/definitions/CreateServiceOrder" + $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\ -- cgit 1.2.3-korg