diff options
| author |   dglFromAtt <dgl@research.att.com> | 2019-04-17 11:42:03 -0400 |
|---|---|---|
| committer | Dominic Lunanuova <dgl@research.att.com> | 2019-04-17 18:17:43 +0000 |
| commit | 6dcab2c56e0adda26d52c3f13f4769780b7399a0 (patch) | |
| tree | 7d24cb7a8a1c90a06d9dcaaccea84bb57dbf739e /docs | |
| parent | 8432144fd04236e1a6a806a5614b8dc92e308624 (diff) | |
Use swagger2doc
Change-Id: Ie400e782c7fa2720bb7e60ea37eca30a252e16db
Signed-off-by: dglFromAtt <dgl@research.att.com>
Issue-ID: DMAAP-922
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-table.rst | 10 | ||||
| -rw-r--r-- | docs/dbcapi-gen.rst | 5 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
3 files changed, 13 insertions, 3 deletions
diff --git a/docs/api-table.rst b/docs/api-table.rst index 9979d94..12a3b32 100644 --- a/docs/api-table.rst +++ b/docs/api-table.rst @@ -1,9 +1,13 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +DMaaP Bus Controller REST API Download docs +=========================================== + +.. toctree:: + :maxdepth: 3 .. this table is provided to allow for download of API documentation in diff formats -..csv-table:: +.. csv-table:: :header: "API name", "Swagger JSON" :widths: 10,5 - "DMaaP Buscontroller API", ":download:`link swagger.json`" + "DMaaP Buscontroller API", ":download:`link <swagger.json>`" diff --git a/docs/dbcapi-gen.rst b/docs/dbcapi-gen.rst new file mode 100644 index 0000000..48378ca --- /dev/null +++ b/docs/dbcapi-gen.rst @@ -0,0 +1,5 @@ +DMaaP Bus Controller REST API 1.1.0 swagger2doc +=============================================== + + +.. swaggerv2doc:: swagger.json diff --git a/docs/index.rst b/docs/index.rst index 352631d..c202dbc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,4 +4,5 @@ :maxdepth: 1 api-table + dbcapi-gen api |