Add documentation for API_Doc endpoint

2019-12-24 08:59:17 -05:00 · 2019-12-24 08:59:17 -05:00 · f48d1e6d40
parent ebcf0cee43
commit f48d1e6d40
1 changed files with 9 additions and 0 deletions
--- a/client-api/pvc-api.py
+++ b/client-api/pvc-api.py
@ -207,6 +207,15 @@ api.add_resource(API_Root, '/')
 # /doc
 class API_Doc(Resource):
    def get(self):
+        """
+        Provide the Swagger API documentation
+        ---
+        tags:
+          - root
+        responses:
+          200:
+            description: OK
+        """
        swagger_data = swagger(pvc_api.app)
        swagger_data['info']['version'] = API_VERSION
        swagger_data['info']['title'] = "PVC Client and Provisioner API"