| Rishi.Chail | 5272dca | 2021-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 |
| shivasubedi | 44beaa3 | 2021-09-13 15:16:30 +0100 | [diff] [blame] | 3 | .. Copyright (C) 2021 Nordix Foundation |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 4 | |
| 5 | .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 6 | .. _design: |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 7 | |
| 8 | |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 9 | CPS Design |
| 10 | ########## |
| 11 | |
| shivasubedi | 44beaa3 | 2021-09-13 15:16:30 +0100 | [diff] [blame] | 12 | .. warning:: draft |
| 13 | |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 14 | .. toctree:: |
| 15 | :maxdepth: 1 |
| 16 | |
| 17 | Offered APIs |
| 18 | ============ |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 19 | |
| Rishi.Chail | 85aebca | 2021-02-24 15:10:58 +0000 | [diff] [blame] | 20 | CPS supports the public APIs listed in the link below: |
| 21 | |
| shivasubedi | 44beaa3 | 2021-09-13 15:16:30 +0100 | [diff] [blame] | 22 | :download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>` |
| 23 | |
| 24 | :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>` |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 25 | |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 26 | Exposed API |
| 27 | ----------- |
| 28 | |
| Rishi.Chail | 85aebca | 2021-02-24 15:10:58 +0000 | [diff] [blame] | 29 | The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). |
| Rishi.Chail | 4359d28 | 2021-03-03 16:36:26 +0000 | [diff] [blame] | 30 | The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments. |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 31 | |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 32 | Specification can be accessed using following URI: |
| Rishi.Chail | 5272dca | 2021-02-23 12:14:24 +0000 | [diff] [blame] | 33 | |
| 34 | .. code-block:: bash |
| 35 | |
| 36 | “http://<hostname>:<port>/v3/api-docs?group=cps-docket” |
| ToineSiebelink | 98c0787 | 2021-04-20 17:33:09 +0100 | [diff] [blame] | 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`. |