aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-reference
diff options
context:
space:
mode:
authorSarah Abouzainah <sabouzainah.ext@orange.com>2021-01-12 14:47:21 +0200
committerSingal, Kapil (ks220y) <ks220y@att.com>2021-01-19 14:40:02 -0500
commitf8c5f58ce8b2b076d5874508873829a33cc545b0 (patch)
tree9aea24972cf90dc4bf4afb6cf900cff1103d60fb /docs/api-reference
parentb524bf9ec0f688e30a24f65758fd014e1e3aedce (diff)
Add new rst guide files
Issue-ID: CCSDK-3070 Issue-ID: CCSDK-3081 Signed-off-by: Sarah Abouzainah <sabouzainah.ext@orange.com> Change-Id: I25c2488ac1ad12966a357f11ecca6e630f440ec0
Diffstat (limited to 'docs/api-reference')
-rw-r--r--docs/api-reference/api-doc-template.rst3
-rw-r--r--docs/api-reference/bp-processor.rst8
2 files changed, 5 insertions, 6 deletions
diff --git a/docs/api-reference/api-doc-template.rst b/docs/api-reference/api-doc-template.rst
index 689180ef6..a0dc0cec5 100644
--- a/docs/api-reference/api-doc-template.rst
+++ b/docs/api-reference/api-doc-template.rst
@@ -2,7 +2,6 @@
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2020 Deutsche Telekom AG.
-
.. This is a template to document new APIs for CDS blueprint processor
.. make use of tabs whenever it fits
@@ -27,7 +26,7 @@ Method 1 Endpoint 1 description
Request
...........
-.. code-block:: curl
+.. code-block:: bash
:caption: **(sample) request**
request command
diff --git a/docs/api-reference/bp-processor.rst b/docs/api-reference/bp-processor.rst
index 00dd7cce6..eb29b093c 100644
--- a/docs/api-reference/bp-processor.rst
+++ b/docs/api-reference/bp-processor.rst
@@ -9,9 +9,9 @@ Introduction
--------------
This section shows all resources and endpoints which CDS BP processor currently provides through a swagger file
-which is automatically created during CDS build process by Swagger Maven Plugin. A corresponding Postman collection is
+which is automatically created during CDS build process by Swagger Maven Plugin. A corresponding Postman collection is
also included. Endpoints can also be described using this template
-:download:`api-doc-template.rst <api-doc-template.rst>` but this is not the prefered way to describe the CDS API.
+:download:`api-doc-template.rst <api-doc-template.rst>` but this is not the preferred way to describe the CDS API.
You can find a sample workflow tutorial :ref:`below <workflow-tutorial>` which will show how to use the endpoints
in the right order. This will give you a better understanding of the CDS Blueprint Processor API.
@@ -19,7 +19,7 @@ in the right order. This will give you a better understanding of the CDS Bluepri
Getting Started
-----------------
-If you cant access a running CDS Blueprint Processor yet, you can choose one of the below options to run it.
+If you cant access a running CDS Blueprint Processor yet, you can choose one of the below options to run it.
Afterwards you can start trying out the API.
* CDS in Microk8s: https://wiki.onap.org/display/DW/Running+CDS+on+Microk8s (RDT link to be added)
@@ -62,7 +62,7 @@ GET ``http://{{host}}:{{port}}/actuator/mappings``
Lists all endpoints from blueprints processor.
-.. code-block:: curl
+.. code-block:: bash
:caption: **request**
curl --location --request GET 'http://localhost:8081/actuator/mappings' \