diff options
| author |   MichaelMorris <michael.morris@est.tech> | 2021-03-18 11:40:48 +0000 |
|---|---|---|
| committer | MichaelMorris <michael.morris@est.tech> | 2021-03-19 23:44:05 +0000 |
| commit | e020ca3c855ec9555213abfdd89e14d72310177d (patch) | |
| tree | fc8628575130e8428a23b2b9b1db7a251e1c73f8 /docs/offeredapis.rst | |
| parent | b1fc8c337d3b9750eff6e62b626c0bc3a1467a88 (diff) | |
Publish swagger files for SDC APIs
I have created a swagger file for each of the APIs as they are currently listed on the architecture page. Some of the files can be easily be combined if some of the APIs are combined. I have created a single file for SDCE-2 and SDCE-5 as it is not possible to seperate as they are both paritially implemented in the same class with overlapping paths
I have copied the generated swagger files to the docs directory as I suspect they need to be under source control for the generation of the readthedocs page
Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-3525
Change-Id: Id42412704311a573e3ebf911ad34d909c1c3f1b2
Diffstat (limited to 'docs/offeredapis.rst')
| -rw-r--r-- | docs/offeredapis.rst | 20 |
1 files changed, 7 insertions, 13 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index f2a320e8b2..e94c3c0a17 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -8,18 +8,12 @@ SDC Offered APIs The list of APIs that SDC offers can be found from the following table: -.. |pdf-icon| image:: images/pdf.png - :width: 40px - -.. |swagger-icon| image:: images/swagger.png - :width: 40px - -.. |html-icon| image:: images/html.png - :width: 40px - .. csv-table:: - :header: "|Swagger-icon|", "|html-icon|", "|pdf-icon|" - :widths: 60,60,60 + :header: "API name", "Swagger JSON" + :widths: 10,5 - "swagger json file", "html doc", "pdf doc" - ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`" + "SDCE-1", ":download:`link <swagger/swagger-sdce-1.json>`" + "SDCE-2 & SDCE-5", ":download:`link <swagger/swagger-sdce-2-sdce-5.json>`" + "SDCE-4", ":download:`link <swagger/swagger-sdce-4.json>`" + "SDCE-6", ":download:`link <swagger/swagger-sdce-6.json>`" + "SDCE-7", ":download:`link <swagger/swagger-sdce-7.json>`" |