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 .. Copyright (C) 2021 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _design:
   7
   8
   9 CPS Design
  10 ##########
  11
  12 .. warning:: draft
  13
  14 .. toctree::
  15    :maxdepth: 1
  16
  17 Offered APIs
  18 ============
  19
  20 CPS supports the public APIs listed in the link below:
  21
  22 :download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>`
  23
  24 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
  25
  26 Exposed API
  27 -----------
  28
  29 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
  30 The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
  31
  32 Specification can be accessed using following URI:
  33
  34 .. code-block:: bash
  35
  36   “http://<hostname>:<port>/v3/api-docs?group=cps-docket”
  37
  38 CPS Path
  39 ========
  40
  41 Several CPS APIs use the cps-path (or cpsPath in Java API) parameter.
  42 The CPS Path is described in detail in :doc:`cps-path`.