diff options
| -rw-r--r-- | docs/architecture/NBI_R1_Developer_Guide.rst | 2 | ||||
| -rw-r--r-- | docs/architecture/architecture.rst | 8 | ||||
| -rw-r--r-- | docs/configuration/configuration.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/installation/installation.rst | 2 | ||||
| -rw-r--r-- | docs/offeredapis/offeredapis.rst | 26 |
6 files changed, 22 insertions, 22 deletions
diff --git a/docs/architecture/NBI_R1_Developer_Guide.rst b/docs/architecture/NBI_R1_Developer_Guide.rst index 2c9c549..893bfc3 100644 --- a/docs/architecture/NBI_R1_Developer_Guide.rst +++ b/docs/architecture/NBI_R1_Developer_Guide.rst @@ -66,7 +66,7 @@ You can view the log output of the application with the following command: `$ docker-compose logs -f nbi` **Testing** -When the app is running, you can access the API at \http://yourhostname:8080/nbi/api/v1/ and fill the url with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status) +When the app is running, you can access the API at :samp:`http://yourhostname:8080/nbi/api/v1` 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 <https://github.com/Huachao/vscode-restclient>`_ See the *restclient* package at root level to find *.vscode/settings.json* configuration file and */json/* package with samples requests that can be run. You can also trigger these endpoints with any RESTful client or automation framework. diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index 8e7b9b9..dc296ab 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -6,17 +6,17 @@ Architecture ============ -*************** +************ 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**. -*************** +******************************************* Global NBI architecture for Beijing release -*************** +******************************************* Following illustration provides a global view about nbi architecture,integration with other ONAP components and API resource/operation provided. diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst index ce45d44..b71d60f 100644 --- a/docs/configuration/configuration.rst +++ b/docs/configuration/configuration.rst @@ -64,9 +64,9 @@ Default values spring.jpa.hibernate.ddl-auto=update spring.jpa.hibernate.naming-strategy=org.hibernate.cfg.ImprovedNamingStrategy -************** +*************** Changing values -************** +*************** To adapt application parameters to your context, you need to set up some environment attributes. For example : diff --git a/docs/index.rst b/docs/index.rst index 2315c73..5196d1f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ .. Copyright 2018 Orange ONAP ExternalAPI / NBI -======================================== +====================== .. toctree:: :maxdepth: 1 diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst index bb392d3..43db47c 100644 --- a/docs/installation/installation.rst +++ b/docs/installation/installation.rst @@ -38,7 +38,7 @@ Steps ----- **Testing** -When the app is running, you can access the API at http://yourhostname:8080/nbi/api/v1/ and fill the url with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status) +When the app is running, you can access the API at :samp:`http://yourhostname:8080/nbi/api/v1/` 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 <https://github.com/Huachao/vscode-restclient>`_ See the *restclient* package at root level to find *.vscode/settings.json* configuration file and */json/* package with samples requests that can be run. You can also trigger these endpoints with any RESTful client or automation framework. diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 9a264ff..3c52aa7 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -5,24 +5,24 @@ Offered APIs ============ -*************** +************ 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**. -*************** +******************************************* Global NBI architecture for Beijing release -*************** +******************************************* Following illustration provides a global view about nbi architecture,integration with other ONAP components and API resource/operation provided. .. image:: images/ONAP_External_ID_Beijing.jpg :width: 800px -*************** +*********** API Version -*************** +*********** APIs are described with a state version with “v” following the API Name, e.g.: nbi/api/v1/productOrder. The schema associated with a REST API must have its version number aligned with that of the REST API. @@ -44,9 +44,9 @@ must be kept For major modifications of the API, not backward compatible and forcing client implementations to be changed, the version number must be updated. -*************** +********* API Table -*************** +********* .. |pdf-icon| image:: images/pdf.png :width: 40px @@ -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 <swaggers/serviceCatalog_1_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "`link <http://editor2.swagger.io/?url=http://onap.readthedocs.io/en/latest/_downloads/serviceCatalog_1_0_0.json>`_", "coming", "coming" - "serviceInventory", ":download:`link <swaggers/serviceInventory_1_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "`link <http://editor2.swagger.io/?url=http://onap.readthedocs.io/en/latest/_downloads/serviceInventory_1_0_0.json>`_", "coming", "coming" - "serviceOrder", ":download:`link <swaggers/serviceOrder_1_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "`link <http://editor2.swagger.io/?url=http://onap.readthedocs.io/en/latest/_downloads/serviceOrder_1_0_0.json>`_", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" + "serviceCatalog", ":download:`link <swaggers/serviceCatalog_1_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming" + "serviceInventory", ":download:`link <swaggers/serviceInventory_1_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming" + "serviceOrder", ":download:`link <swaggers/serviceOrder_1_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" *************** @@ -186,9 +186,9 @@ With the current version of APIs used from SO and AAI we need to manage a ‘cus • State management: States are only managed by ServiceOrder component and could not be updated from north side via API. Accordingly to service order item fulfillment progress, order item state are updated. Order state is automatically updated based on item state. -*************** +******** API flow -*************** +******** API Flow illustration (with example messages) is described in this document: :download:`nbicallflow.pdf <pdf/nbicallflow.pdf>` |