summaryrefslogtreecommitdiffstats
path: root/docs/design.rst
diff options
context:
space:
mode:
authorRuslan Kashapov <ruslan.kashapov@pantheon.tech>2021-03-02 16:48:41 +0200
committerRishi Chail <rishi.chail@est.tech>2021-03-22 12:38:02 +0000
commitbe5cd5b36e092d1fb0a34d2a7007da9a5c7a2378 (patch)
tree933bf948ce9a3a8e592373258fa55a10e7a3f930 /docs/design.rst
parentd8bcd1756df6bae0fc6b794ea4bf10a4e8b7e541 (diff)
Docs: overview, architecture, design, modeling
Issue-ID: CPS-268 Change-Id: I31480a9a6186af0ddedae4f0eca06a744a2e2d64 Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech> (cherry picked from commit 55dc654964942aa67c48f09b0ba56059be8e923b)
Diffstat (limited to 'docs/design.rst')
-rwxr-xr-xdocs/design.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/design.rst b/docs/design.rst
new file mode 100755
index 0000000000..4f1bf1ee13
--- /dev/null
+++ b/docs/design.rst
@@ -0,0 +1,31 @@
+.. 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
+.. _design:
+
+
+CPS Design
+##########
+
+.. toctree::
+ :maxdepth: 1
+
+Offered APIs
+============
+
+CPS supports the public APIs listed in the link below:
+
+:download:`OpenApi Specification <api/swagger/openapi.yml>`
+
+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 accessed using following URI:
+
+.. code-block:: bash
+
+ “http://<hostname>:<port>/v3/api-docs?group=cps-docket”