diff options
Diffstat (limited to 'docs/design.rst')
-rwxr-xr-x | docs/design.rst | 31 |
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” |