summaryrefslogtreecommitdiffstats
path: root/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst
blob: 24dd1ef7eb3f99f11ec4886792852c2cf948c10a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
..
 This work is licensed under a Creative Commons Attribution 4.0
 International License.

=========================================
MultiCloud K8sPlugin API v1 Specification
=========================================

The is the specification for MultiCloud K8sPlugin API version v1.

API Swagger
===========

The specification of the K8sPlugin v1 API in Swagger format:

:download:`k8splugin-v1-api-swagger.json <k8splugin/k8splugin-v1-api-swagger.json>`

API Catalog
===========

.. warning::
   In the used Sphinx plugin `sphinxcontrib-swaggerdoc` some information of the swagger file is not
   rendered completely, e.g. the request body. Use your favorite Swagger Editor and paste the swagger file
   to get a complete view of the API reference, e.g. on https://editor.swagger.io/.

.. swaggerv2doc:: k8splugin/k8splugin-v1-api-swagger.json