From 55dc654964942aa67c48f09b0ba56059be8e923b Mon Sep 17 00:00:00 2001 From: Ruslan Kashapov Date: Tue, 2 Mar 2021 16:48:41 +0200 Subject: Docs: overview, architecture, design, modeling Issue-ID: CPS-268 Change-Id: I31480a9a6186af0ddedae4f0eca06a744a2e2d64 Signed-off-by: Ruslan Kashapov --- docs/design.rst | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100755 docs/design.rst (limited to 'docs/design.rst') diff --git a/docs/design.rst b/docs/design.rst new file mode 100755 index 000000000..4f1bf1ee1 --- /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 ` + +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://:/v3/api-docs?group=cps-docket” -- cgit 1.2.3-korg