summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2019-05-15 03:36:05 +0000
committerGerrit Code Review <gerrit@onap.org>2019-05-15 03:36:05 +0000
commit9a1b5bb6560fd49f64a0082259974a85db298c7d (patch)
treeaf293e0a8d1f2762ef2a6f00d99b34740124a488 /docs
parent8c71b479c9f0ad8c1a5c4984cb6b5826b9fcf3f6 (diff)
parent9fcfeecdd61afd0c7eb22947d6b96f5b3f58d546 (diff)
Merge "Correction to documentation guide for API"
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/api-swagger-guide.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/api-swagger-guide.rst b/docs/guides/onap-developer/how-to-use-docs/api-swagger-guide.rst
index 9d3a7f6fc..bb4706c2e 100644
--- a/docs/guides/onap-developer/how-to-use-docs/api-swagger-guide.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/api-swagger-guide.rst
@@ -55,14 +55,19 @@ The code is available here:
.. note::
The syntax of <myAPI1.json> is to be taken literally. Keep '<' and '>'.
-.. note::
- Note the ā€œvā€ in swaggerv2doc!
- If your JSON file has multiple endpoints, this directive does not preserve the order.
API Swagger
-----------
For each API, the ``swaggerv2doc`` directive must be used as follows:
+.. note::
+ Note the ā€œvā€ in swaggerv2doc!
+ If your JSON file has multiple endpoints, this directive does not preserve the order.
+
+.. note::
+ swaggerv2doc directive may generate errors when Swagger file contains specific
+ information. In such case, do not use this direcive.
+
.. code:: rst
myAPI1