summary |
shortlog |
log |
commit | commitdiff |
review |
tree
raw |
patch |
inline | side by side (from parent 1:
29df3d1)
Add note when swaggerv2doc directive is not working
Issue-ID: DOC-426
Change-Id: I19871c820f721016625ee7979632d2e2dfea80bb
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
.. note::
The syntax of <myAPI1.json> is to be taken literally. Keep '<' and '>'.
.. 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:
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.
+