add token param to openapi #TASK-5914

opencb · Jan 13, 2025 · 8931e46 · 8931e46
1 parent 5434d2f
commit 8931e46
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/opencga-client/src/main/R/R/Meta-methods.R b/opencga-client/src/main/R/R/Meta-methods.R
@@ -23,7 +23,7 @@
 #' | api | /{apiVersion}/meta/api | category |
 #' | fail | /{apiVersion}/meta/fail |  |
 #' | model | /{apiVersion}/meta/model | model |
-#' | openapi | /{apiVersion}/meta/openapi | category |
+#' | openapi | /{apiVersion}/meta/openapi | token |
 #' | ping | /{apiVersion}/meta/ping |  |
 #' | status | /{apiVersion}/meta/status |  |
 #'
@@ -62,7 +62,7 @@ setMethod("metaClient", "OpencgaR", function(OpencgaR, endpointName, params=NULL
 
         #' @section Endpoint /{apiVersion}/meta/openapi:
         #' Opencga openapi json.
-        #' @param category List of categories to get API from.
+        #' @param token List of categories to get API from.
         openapi=fetchOpenCGA(object=OpencgaR, category="meta", categoryId=NULL, subcategory=NULL, subcategoryId=NULL,
                 action="openapi", params=params, httpMethod="GET", as.queryParam=NULL, ...),
 

diff --git a/opencga-client/src/main/java/org/opencb/opencga/client/rest/clients/MetaClient.java b/opencga-client/src/main/java/org/opencb/opencga/client/rest/clients/MetaClient.java
@@ -91,7 +91,7 @@ public RestResponse<String> model(ObjectMap params) throws ClientException {
     /**
      * Opencga openapi json.
      * @param params Map containing any of the following optional parameters.
-     *       category: List of categories to get API from.
+     *       token: List of categories to get API from.
      * @return a RestResponse object.
      * @throws ClientException ClientException if there is any server error.
      */

diff --git a/opencga-client/src/main/javascript/Meta.js b/opencga-client/src/main/javascript/Meta.js
@@ -70,7 +70,7 @@ export default class Meta extends OpenCGAParentClass {
 
     /** Opencga openapi json
     * @param {Object} [params] - The Object containing the following optional parameters:
-    * @param {String} [params.category] - List of categories to get API from.
+    * @param {String} [params.token] - List of categories to get API from.
     * @returns {Promise} Promise object in the form of RestResponse instance.
     */
     openapi(params) {

diff --git a/opencga-client/src/main/python/pyopencga/rest_clients/meta_client.py b/opencga-client/src/main/python/pyopencga/rest_clients/meta_client.py
@@ -60,7 +60,7 @@ def openapi(self, **options):
         Opencga openapi json.
         PATH: /{apiVersion}/meta/openapi
 
-        :param str category: List of categories to get API from.
+        :param str token: List of categories to get API from.
         """
 
         return self._get(category='meta', resource='openapi', **options)

diff --git a/...erver/src/main/java/org/opencb/opencga/server/generator/openapi/JsonOpenApiGenerator.java b/...erver/src/main/java/org/opencb/opencga/server/generator/openapi/JsonOpenApiGenerator.java
@@ -35,7 +35,7 @@ public Swagger generateJsonOpenApi(ApiCommons apiCommons, String token) {
         bearerAuth.put("type", "apiKey");
         bearerAuth.put("name", "Authorization");
         bearerAuth.put("in", "header");
-        bearerAuth.put("description", "Use 'Bearer <your-token>' to authenticate");
+        bearerAuth.put("description", "Use 'Bearer <token>' to authenticate");
         securityDefinitions.put("BearerAuth", bearerAuth);
         swagger.setSecurityDefinitions(securityDefinitions);