| Lukasz Rajewski | 0cfbc57 | 2021-02-24 16:51:59 +0100 | [diff] [blame] | 1 | .. |
| 2 | This work is licensed under a Creative Commons Attribution 4.0 |
| 3 | International License. |
| 4 | |
| 5 | ========================================= |
| 6 | MultiCloud K8sPlugin API v1 Specification |
| 7 | ========================================= |
| 8 | |
| 9 | The is the specification for MultiCloud K8sPlugin API version v1. |
| 10 | |
| 11 | API Swagger |
| 12 | =========== |
| 13 | |
| 14 | The specification of the K8sPlugin v1 API in Swagger format: |
| 15 | |
| 16 | :download:`k8splugin-v1-api-swagger.json <k8splugin/k8splugin-v1-api-swagger.json>` |
| 17 | |
| 18 | API Catalog |
| 19 | =========== |
| 20 | |
| 21 | .. warning:: |
| 22 | In the used Sphinx plugin `sphinxcontrib-swaggerdoc` some information of the swagger file is not |
| 23 | rendered completely, e.g. the request body. Use your favorite Swagger Editor and paste the swagger file |
| 24 | to get a complete view of the API reference, e.g. on https://editor.swagger.io/. |
| 25 | |
| 26 | .. swaggerv2doc:: k8splugin/k8splugin-v1-api-swagger.json |