From 0cfbc57b64e81ced9ce3a744f25ebd1b402b8108 Mon Sep 17 00:00:00 2001 From: Lukasz Rajewski Date: Wed, 24 Feb 2021 16:51:59 +0100 Subject: K8s Plugin v1 API Specification K8s Plugin v1 API Specification Issue-ID: MULTICLOUD-1296 Signed-off-by: Lukasz Rajewski Change-Id: Iecfbe657c315c3b00c0ebcbb6f4f097eb4d56009 --- docs/MultiCloud-K8sPlugin-APIv1-Specification.rst | 26 +++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/MultiCloud-K8sPlugin-APIv1-Specification.rst (limited to 'docs/MultiCloud-K8sPlugin-APIv1-Specification.rst') diff --git a/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst b/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst new file mode 100644 index 0000000..24dd1ef --- /dev/null +++ b/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst @@ -0,0 +1,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 ` + +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 -- cgit 1.2.3-korg