docs/offeredapis.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 .. _offeredapis:
   6
   7
   8 CPS Offered APIs
   9 ================
  10
  11 CPS supports the public APIs listed in the link below:
  12
  13 :download:`OpenApi Specification <api/swagger/openapi.yml>`
  14
  15 .. toctree::
  16    :maxdepth: 1
  17
  18 Exposed API
  19 -----------
  20
  21 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
  22 The OAS 3, which is based on the original "Swagger Specification," is being widely used in API developments.
  23
  24 Specification can be accesed locally at :
  25
  26 .. code-block:: bash
  27
  28   “http://<hostname>:<port>/v3/api-docs?group=cps-docket”
  29
  30