summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/offeredapis.rst')
-rwxr-xr-xdocs/offeredapis.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100755
index 0000000000..912c5d1960
--- /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”
+
+