summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2019-05-13 13:09:08 +0000
committerEric Debeau <eric.debeau@orange.com>2019-05-13 13:11:44 +0000
commit9fcfeecdd61afd0c7eb22947d6b96f5b3f58d546 (patch)
tree049ea2a138e4e4532a915366fa18c87d83bee18b
parent29df3d143bbbf135df226622b28c2b79f26817c2 (diff)
Correction to documentation guide for API
Add note when swaggerv2doc directive is not working Issue-ID: DOC-426 Change-Id: I19871c820f721016625ee7979632d2e2dfea80bb Signed-off-by: Eric Debeau <eric.debeau@orange.com>
-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