Skip to content

Commit

Permalink
client: regenerate clients, #TASK-6568
Browse files Browse the repository at this point in the history
  • Loading branch information
pfurio committed Jul 18, 2024
1 parent bea231f commit 7907502
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import org.opencb.opencga.app.cli.main.options.OrganizationsCommandOptions;
import org.opencb.opencga.catalog.exceptions.CatalogAuthenticationException;
import org.opencb.opencga.catalog.utils.ParamUtils.AddRemoveAction;
import org.opencb.opencga.catalog.utils.ParamUtils.BasicUpdateAction;
import org.opencb.opencga.catalog.utils.ParamUtils.UpdateAction;
import org.opencb.opencga.client.exceptions.ClientException;
import org.opencb.opencga.core.common.JacksonUtils;
Expand Down Expand Up @@ -214,6 +215,7 @@ private RestResponse<Note> updateNotes() throws Exception {
ObjectMap queryParams = new ObjectMap();
queryParams.putIfNotEmpty("include", commandOptions.include);
queryParams.putIfNotEmpty("exclude", commandOptions.exclude);
queryParams.putIfNotNull("tagsAction", commandOptions.tagsAction);
queryParams.putIfNotNull("includeResult", commandOptions.includeResult);


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ private RestResponse<Note> updateNotes() throws Exception {
ObjectMap queryParams = new ObjectMap();
queryParams.putIfNotEmpty("include", commandOptions.include);
queryParams.putIfNotEmpty("exclude", commandOptions.exclude);
queryParams.putIfNotNull("tagsAction", commandOptions.tagsAction);
queryParams.putIfNotNull("includeResult", commandOptions.includeResult);


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,9 @@ public class UpdateNotesCommandOptions {
@Parameter(names = {"--id"}, description = "Note unique identifier.", required = true, arity = 1)
public String id;

@Parameter(names = {"--tags-action"}, description = "Action to be performed if the array of tags is being updated.", required = false, arity = 1)
public String tagsAction = "ADD";

@Parameter(names = {"--include-result"}, description = "Flag indicating to include the created or updated document result in the response", required = false, help = true, arity = 0)
public boolean includeResult = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,9 @@ public class UpdateNotesCommandOptions {
@Parameter(names = {"--id"}, description = "Note unique identifier.", required = true, arity = 1)
public String id;

@Parameter(names = {"--tags-action"}, description = "Action to be performed if the array of tags is being updated.", required = false, arity = 1)
public String tagsAction = "ADD";

@Parameter(names = {"--include-result"}, description = "Flag indicating to include the created or updated document result in the response", required = false, help = true, arity = 0)
public boolean includeResult = false;

Expand Down
3 changes: 2 additions & 1 deletion opencga-client/src/main/R/R/Organization-methods.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#' | createNotes | /{apiVersion}/organizations/notes/create | include, exclude, includeResult, body[*] |
#' | searchNotes | /{apiVersion}/organizations/notes/search | include, exclude, creationDate, modificationDate, id, scope, visibility, uuid, userId, tags, version |
#' | deleteNotes | /{apiVersion}/organizations/notes/{id}/delete | id[*], includeResult |
#' | updateNotes | /{apiVersion}/organizations/notes/{id}/update | include, exclude, id[*], includeResult, body[*] |
#' | updateNotes | /{apiVersion}/organizations/notes/{id}/update | include, exclude, id[*], tagsAction, includeResult, body[*] |
#' | userUpdateStatus | /{apiVersion}/organizations/user/{user}/status/update | include, exclude, user[*], organization, includeResult, body[*] |
#' | updateUser | /{apiVersion}/organizations/user/{user}/update | include, exclude, user[*], organization, includeResult, body[*] |
#' | updateConfiguration | /{apiVersion}/organizations/{organization}/configuration/update | include, exclude, organization[*], includeResult, authenticationOriginsAction, body[*] |
Expand Down Expand Up @@ -85,6 +85,7 @@ setMethod("organizationClient", "OpencgaR", function(OpencgaR, id, organization,
#' @param include Fields included in the response, whole JSON path must be provided.
#' @param exclude Fields excluded in the response, whole JSON path must be provided.
#' @param id Note unique identifier.
#' @param tagsAction Action to be performed if the array of tags is being updated. Allowed values: ['ADD SET REMOVE']
#' @param includeResult Flag indicating to include the created or updated document result in the response.
#' @param data JSON containing the Note fields to be updated.
updateNotes=fetchOpenCGA(object=OpencgaR, category="organizations", categoryId=NULL, subcategory="notes",
Expand Down
3 changes: 2 additions & 1 deletion opencga-client/src/main/R/R/Study-methods.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#' | createNotes | /{apiVersion}/studies/{study}/notes/create | include, exclude, study[*], includeResult, body[*] |
#' | searchNotes | /{apiVersion}/studies/{study}/notes/search | include, exclude, study[*], creationDate, modificationDate, id, uuid, userId, tags, visibility, version |
#' | deleteNotes | /{apiVersion}/studies/{study}/notes/{id}/delete | study[*], id[*], includeResult |
#' | updateNotes | /{apiVersion}/studies/{study}/notes/{id}/update | include, exclude, study[*], id[*], includeResult, body[*] |
#' | updateNotes | /{apiVersion}/studies/{study}/notes/{id}/update | include, exclude, study[*], id[*], tagsAction, includeResult, body[*] |
#' | permissionRules | /{apiVersion}/studies/{study}/permissionRules | study[*], entity[*] |
#' | updatePermissionRules | /{apiVersion}/studies/{study}/permissionRules/update | study[*], entity[*], action, body[*] |
#' | runTemplates | /{apiVersion}/studies/{study}/templates/run | study[*], jobId, jobDependsOn, jobDescription, jobTags, jobScheduledStartTime, jobPriority, jobDryRun, body[*] |
Expand Down Expand Up @@ -191,6 +191,7 @@ setMethod("studyClient", "OpencgaR", function(OpencgaR, group, id, members, stud
#' @param exclude Fields excluded in the response, whole JSON path must be provided.
#' @param study Study [[organization@]project:]study where study and project can be either the ID or UUID.
#' @param id Note unique identifier.
#' @param tagsAction Action to be performed if the array of tags is being updated. Allowed values: ['ADD SET REMOVE']
#' @param includeResult Flag indicating to include the created or updated document result in the response.
#' @param data JSON containing the Note fields to be updated.
updateNotes=fetchOpenCGA(object=OpencgaR, category="studies", categoryId=study, subcategory="notes",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ public RestResponse<Note> deleteNotes(String id, ObjectMap params) throws Client
* @param params Map containing any of the following optional parameters.
* include: Fields included in the response, whole JSON path must be provided.
* exclude: Fields excluded in the response, whole JSON path must be provided.
* tagsAction: Action to be performed if the array of tags is being updated.
* includeResult: Flag indicating to include the created or updated document result in the response.
* @return a RestResponse object.
* @throws ClientException ClientException if there is any server error.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ public RestResponse<Note> deleteNotes(String study, String id, ObjectMap params)
* @param params Map containing any of the following optional parameters.
* include: Fields included in the response, whole JSON path must be provided.
* exclude: Fields excluded in the response, whole JSON path must be provided.
* tagsAction: Action to be performed if the array of tags is being updated.
* includeResult: Flag indicating to include the created or updated document result in the response.
* @return a RestResponse object.
* @throws ClientException ClientException if there is any server error.
Expand Down
2 changes: 2 additions & 0 deletions opencga-client/src/main/javascript/Organization.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ export default class Organization extends OpenCGAParentClass {
* @param {Object} [params] - The Object containing the following optional parameters:
* @param {String} [params.include] - Fields included in the response, whole JSON path must be provided.
* @param {String} [params.exclude] - Fields excluded in the response, whole JSON path must be provided.
* @param {"ADD SET REMOVE"} [params.tagsAction = "ADD"] - Action to be performed if the array of tags is being updated. The default
* value is ADD.
* @param {Boolean} [params.includeResult = "false"] - Flag indicating to include the created or updated document result in the response.
* The default value is false.
* @returns {Promise} Promise object in the form of RestResponse instance.
Expand Down
2 changes: 2 additions & 0 deletions opencga-client/src/main/javascript/Study.js
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,8 @@ export default class Study extends OpenCGAParentClass {
* @param {Object} [params] - The Object containing the following optional parameters:
* @param {String} [params.include] - Fields included in the response, whole JSON path must be provided.
* @param {String} [params.exclude] - Fields excluded in the response, whole JSON path must be provided.
* @param {"ADD SET REMOVE"} [params.tagsAction = "ADD"] - Action to be performed if the array of tags is being updated. The default
* value is ADD.
* @param {Boolean} [params.includeResult = "false"] - Flag indicating to include the created or updated document result in the response.
* The default value is false.
* @returns {Promise} Promise object in the form of RestResponse instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ def update_notes(self, id, data=None, **options):
must be provided.
:param str exclude: Fields excluded in the response, whole JSON path
must be provided.
:param str tags_action: Action to be performed if the array of tags is
being updated. Allowed values: ['ADD SET REMOVE']
:param bool include_result: Flag indicating to include the created or
updated document result in the response.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,8 @@ def update_notes(self, study, id, data=None, **options):
must be provided.
:param str exclude: Fields excluded in the response, whole JSON path
must be provided.
:param str tags_action: Action to be performed if the array of tags is
being updated. Allowed values: ['ADD SET REMOVE']
:param bool include_result: Flag indicating to include the created or
updated document result in the response.
"""
Expand Down

0 comments on commit 7907502

Please sign in to comment.