aboutsummaryrefslogtreecommitdiffstats
path: root/docs/architecture
diff options
context:
space:
mode:
authorRene Robert <rene.robert@orange.com>2018-04-26 18:56:42 +0000
committerRene Robert <rene.robert@orange.com>2018-04-26 18:56:42 +0000
commita9644963d44ae5fa7ec91f016f8871590dd25e28 (patch)
treee24072954ca261105efa813b18b63b7a096366fa /docs/architecture
parent3ae950ed3df4fbdb9d53e7b6b5a085dc1c34f878 (diff)
correct some rst files
Issue-ID: EXTAPI-74 Change-Id: Iafe3a129da0059cc666f30644ea914b1d576a00f Signed-off-by: Rene Robert <rene.robert@orange.com>
Diffstat (limited to 'docs/architecture')
-rw-r--r--docs/architecture/NBI_R1_Developer_Guide.rst2
-rw-r--r--docs/architecture/architecture.rst8
2 files changed, 5 insertions, 5 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.