Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 98c078768b2ee6c8ce1a910f42ce46845eacc2c1 / . / docs / design.rst
blob: c7691ae35c0e8849add8e4e367970ce08d1decea [file] [log] [blame]
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
Ruslan Kashapov55dc6542021-03-02 16:48:41 +0200[diff] [blame]5.. _design:
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]6
7
Ruslan Kashapov55dc6542021-03-02 16:48:41 +0200[diff] [blame]8CPS Design
9##########
10
11.. toctree::
12 :maxdepth: 1
13
14Offered APIs
15============
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]16
Rishi.Chail85aebca2021-02-24 15:10:58 +0000[diff] [blame]17CPS supports the public APIs listed in the link below:
18
19:download:`OpenApi Specification <api/swagger/openapi.yml>`
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]20
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]21Exposed API
22-----------
23
Rishi.Chail85aebca2021-02-24 15:10:58 +0000[diff] [blame]24The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]25The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]26
Ruslan Kashapov55dc6542021-03-02 16:48:41 +0200[diff] [blame]27Specification can be accessed using following URI:
Rishi.Chail5272dca2021-02-23 12:14:24 +0000[diff] [blame]28
29.. code-block:: bash
30
31 “http://<hostname>:<port>/v3/api-docs?group=cps-docket”
ToineSiebelink98c07872021-04-20 17:33:09 +0100[diff] [blame^]32
33CPS Path
34========
35
36Several CPS APIs use the cps-path (or cpsPath in Java API) parameter.
37The CPS Path is described in detail in :doc:`cps-path`.