From: Rich Bennett Date: Thu, 18 Apr 2019 11:01:37 +0000 (+0000) Subject: Merge "Correction to documentation guide for API" X-Git-Tag: elalto.1.5.2~4521 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=82c5c4b223de022219688247b0031bdc8e6bc23d;hp=c36cfa0178e57cff4d601b210fa0e80d039b52e7;p=doc.git Merge "Correction to documentation guide for API" --- 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 d5e2099a5..9d3a7f6fc 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 @@ -16,7 +16,8 @@ The API should be described using OpenAPI specifications and available as a A Swagger editor is available here ``_ to generate such JSON files. -As a result, you should get one JSON file per API: +As a result, you should get one JSON file per API. For example the project +**my** has 2 API: **myAPI1** and **myAPI2**. - myAPI1.json - myAPI2.json @@ -35,17 +36,28 @@ We propose the following table: "myAPI1", ":download:`link `" "myAPI12", ":download:`link `" +.. note:: + During documentation merge/publish at RTD, any file referenced in an RST file with + ':download:' and relative path to a contributing project repository is copied, uniquely + named, and published with the generated HTML pages. The code is available here: .. code:: rst - ..csv-table:: - :header: "API name", "Swagger JSON" - :widths: 10,5 + .. csv-table:: + :header: "API name", "Swagger JSON" + :widths: 10,5 - "myAPI1", ":download:`link `" - "myAPI2", ":download:`link `" + "myAPI1", ":download:`link `" + "myAPI2", ":download:`link `" + +.. 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 -----------