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>

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 9d3a7f6..bb4706c 100644 (file)
--- 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