summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis.rst
diff options
context:
space:
mode:
authorToine Siebelink <toine.siebelink@est.tech>2021-02-24 13:16:22 +0000
committerGerrit Code Review <gerrit@onap.org>2021-02-24 13:16:22 +0000
commit257b6cba072010dd24f1890d70b5ee08fea1d81b (patch)
tree7bfdef0d2ded397f964e41c15555fe04b7d5ac05 /docs/offeredapis.rst
parent8c9b592e7e04d2d2a27c9da6befe7ea13aedadfd (diff)
parent5272dca758641a7752a3a4d9ccc9c4709aa68c4d (diff)
Merge "Initial/docs folder setup"
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 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”
+
+