X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fhow-to-use-docs%2Fapi-swagger-guide.rst;h=bb4706c2e0146fe189ee21576b7e4f7bf9012a62;hb=9fcfeecdd61afd0c7eb22947d6b96f5b3f58d546;hp=9d3a7f6fc89d4bf1fc0776a103fef59fa6d9f183;hpb=29df3d143bbbf135df226622b28c2b79f26817c2;p=doc.git 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 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