diff options
| author |   Rishi.Chail <rishi.chail@est.tech> | 2021-02-23 12:14:24 +0000 |
|---|---|---|
| committer | Rishi.Chail <rishi.chail@est.tech> | 2021-02-24 12:46:43 +0000 |
| commit | 5272dca758641a7752a3a4d9ccc9c4709aa68c4d (patch) | |
| tree | 7c0b9c5beeb7a097efe349bae0d1bc0a5aaafb92 /docs/offeredapis.rst | |
| parent | 5ecf25627589001888c68e9f413c28ccaac69c26 (diff) | |
Initial/docs folder setup
Issue-ID: CPS-176
Signed-off-by: Rishi.Chail <rishi.chail@est.tech>
Change-Id: I765ac67703303982a28f301ece70d87605c2e835
Diffstat (limited to 'docs/offeredapis.rst')
| -rwxr-xr-x | docs/offeredapis.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst new file mode 100755 index 000000000..912c5d196 --- /dev/null +++ b/docs/offeredapis.rst @@ -0,0 +1,29 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING +.. _offeredapis: + + +CPS Offered APIs +================ + +CPS supports the public APIs listed in the links below: + +.. toctree:: + :maxdepth: 1 + + +Exposed API +----------- + +The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). The OAS 3, which is based on +the original "Swagger Specification," is being widely used in API developments. + +Specification can be accesed locally at : + +.. code-block:: bash + + “http://<hostname>:<port>/v3/api-docs?group=cps-docket” + + |