From 5272dca758641a7752a3a4d9ccc9c4709aa68c4d Mon Sep 17 00:00:00 2001 From: "Rishi.Chail" Date: Tue, 23 Feb 2021 12:14:24 +0000 Subject: Initial/docs folder setup Issue-ID: CPS-176 Signed-off-by: Rishi.Chail Change-Id: I765ac67703303982a28f301ece70d87605c2e835 --- docs/offeredapis.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100755 docs/offeredapis.rst (limited to 'docs/offeredapis.rst') 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://:/v3/api-docs?group=cps-docket” + + -- cgit 1.2.3-korg