docs/design.rst

   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
   5 .. _design:
   6
   7
   8 CPS Design
   9 ##########
  10
  11 .. toctree::
  12    :maxdepth: 1
  13
  14 Offered APIs
  15 ============
  16
  17 CPS supports the public APIs listed in the link below:
  18
  19 :download:`OpenApi Specification <api/swagger/openapi.yml>`
  20
  21 Exposed API
  22 -----------
  23
  24 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
  25 The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
  26
  27 Specification can be accessed using following URI:
  28
  29 .. code-block:: bash
  30
  31   “http://<hostname>:<port>/v3/api-docs?group=cps-docket”
  32
  33 CPS Path
  34 ========
  35
  36 Several CPS APIs use the cps-path (or cpsPath in Java API) parameter.
  37 The CPS Path is described in detail in :doc:`cps-path`.