Minor apidocs update (#2964)

* Update apidocs with security and base path * Move apidocs files to be compliant with the buf lint command * Use the same api version as in other packages (v1alpha1)
vmware-tanzu · Jun 10, 2021 · a4996b5 · a4996b5
1 parent d33aa86
commit a4996b5
Show file tree

Hide file tree

Showing 3 changed files with 192 additions and 137 deletions.
diff --git a/cmd/kubeapps-apis/docs/kubeapps-apis.swagger.json b/cmd/kubeapps-apis/docs/kubeapps-apis.swagger.json
@@ -25,8 +25,10 @@
     }
   ],
   "host": "127.0.0.1:8080",
+  "basePath": "/apis",
   "schemes": [
-    "http"
+    "http",
+    "https"
   ],
   "consumes": [
     "application/json"
@@ -45,6 +47,10 @@
               "$ref": "#/definitions/v1alpha1GetPackageMetaResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -88,6 +94,10 @@
               "$ref": "#/definitions/v1alpha1GetPackageRepositoriesResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -126,6 +136,10 @@
               "$ref": "#/definitions/v1alpha1GetAvailablePackagesResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -165,6 +179,10 @@
               "$ref": "#/definitions/v1alpha1GetConfiguredPluginsResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -188,6 +206,10 @@
               "$ref": "#/definitions/v1alpha1GetPackageMetaResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -232,6 +254,10 @@
               "$ref": "#/definitions/v1alpha1GetPackageRepositoriesResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -271,6 +297,10 @@
               "$ref": "#/definitions/v1alpha1GetAvailablePackagesResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -310,6 +340,10 @@
               "$ref": "#/definitions/v1alpha1GetPackageRepositoriesResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -349,6 +383,10 @@
               "$ref": "#/definitions/v1alpha1GetAvailablePackagesResponse"
             }
           },
+          "401": {
+            "description": "Returned when the user does not have permission to access the resource.",
+            "schema": {}
+          },
           "default": {
             "description": "An unexpected error response.",
             "schema": {
@@ -628,6 +666,18 @@
       "title": "Plugin"
     }
   },
+  "securityDefinitions": {
+    "ApiKeyAuth": {
+      "type": "apiKey",
+      "name": "Authorization",
+      "in": "header"
+    }
+  },
+  "security": [
+    {
+      "ApiKeyAuth": []
+    }
+  ],
   "externalDocs": {
     "description": "Kuebapps GitHub repository",
     "url": "https://github.com/kubeapps/kubeapps"