This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch api in repository https://gitbox.apache.org/repos/asf/camel.git
commit c0b66ca597ed62576b9d25b668dbbde947b051f4 Author: Claus Ibsen <[email protected]> AuthorDate: Wed Sep 16 09:36:07 2020 +0200 CAMEL-15478: Improved docs --- .../apache/camel/component/box/api/BoxCollaborationsManager.java | 3 --- .../org/apache/camel/component/box/api/BoxCommentsManager.java | 8 +------- .../org/apache/camel/component/box/api/BoxEventLogsManager.java | 6 ------ .../java/org/apache/camel/component/box/api/BoxEventsManager.java | 6 ------ .../java/org/apache/camel/component/box/api/BoxFilesManager.java | 6 ------ .../org/apache/camel/component/box/api/BoxFoldersManager.java | 6 ------ .../java/org/apache/camel/component/box/api/BoxGroupsManager.java | 6 ------ .../java/org/apache/camel/component/box/api/BoxSearchManager.java | 6 ------ .../java/org/apache/camel/component/box/api/BoxTasksManager.java | 6 ------ .../java/org/apache/camel/component/box/api/BoxUsersManager.java | 6 ------ .../box/BoxCollaborationsManagerEndpointConfiguration.java | 2 +- .../component/box/BoxCommentsManagerEndpointConfiguration.java | 4 ++-- .../component/box/BoxEventLogsManagerEndpointConfiguration.java | 2 +- .../component/box/BoxEventsManagerEndpointConfiguration.java | 2 +- .../camel/component/box/BoxFilesManagerEndpointConfiguration.java | 2 +- .../component/box/BoxFoldersManagerEndpointConfiguration.java | 2 +- .../component/box/BoxGroupsManagerEndpointConfiguration.java | 2 +- .../component/box/BoxSearchManagerEndpointConfiguration.java | 2 +- .../camel/component/box/BoxTasksManagerEndpointConfiguration.java | 2 +- .../camel/component/box/BoxUsersManagerEndpointConfiguration.java | 2 +- 20 files changed, 12 insertions(+), 69 deletions(-) diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCollaborationsManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCollaborationsManager.java index 5e537d6..44027bc 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCollaborationsManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCollaborationsManager.java @@ -27,10 +27,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Collaborations Manager - * <p> * Provides operations to manage Box collaborations. - * */ public class BoxCollaborationsManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCommentsManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCommentsManager.java index 79ea1ac..4dcf6f9 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCommentsManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxCommentsManager.java @@ -26,13 +26,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Comments Manager - * - * <p> * Provides operations to manage Box comments. - * - * - * */ public class BoxCommentsManager { @@ -55,7 +49,7 @@ public class BoxCommentsManager { /** * Add comment to file. * - * @param fileId - the id of file to rename. + * @param fileId - the id of file. * @param message - the comment's message. * @return The commented file. */ diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventLogsManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventLogsManager.java index f6cc056..52eda60 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventLogsManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventLogsManager.java @@ -29,13 +29,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Event Logs Manager - * - * <p> * Provides operations to read Box enterprise (admin) event logs. - * - * - * */ public class BoxEventLogsManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventsManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventsManager.java index 8db5dc5..16262c1 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventsManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxEventsManager.java @@ -24,13 +24,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Events Manager - * - * <p> * Provides operations to manage Box events. - * - * - * */ public class BoxEventsManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java index a43812c..756d509 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java @@ -39,13 +39,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Files Manager - * - * <p> * Provides operations to manage Box files. - * - * - * */ public class BoxFilesManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFoldersManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFoldersManager.java index 9294ec9..a1fcca7 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFoldersManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFoldersManager.java @@ -31,13 +31,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Folders Manager - * - * <p> * Provides operations to manage Box folders. - * - * - * */ public class BoxFoldersManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxGroupsManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxGroupsManager.java index 3a879c9..e35f6dd 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxGroupsManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxGroupsManager.java @@ -28,13 +28,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Groups Manager - * - * <p> * Provides operations to manage Box groups. - * - * - * */ public class BoxGroupsManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxSearchManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxSearchManager.java index 974c05e..e63d9f8 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxSearchManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxSearchManager.java @@ -30,13 +30,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Search Manager - * - * <p> * Provides operations to manage Box searches. - * - * - * */ public class BoxSearchManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxTasksManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxTasksManager.java index 1140188..bf3527e 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxTasksManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxTasksManager.java @@ -29,13 +29,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Tasks Manager - * - * <p> * Provides operations to manage Box tasks. - * - * - * */ public class BoxTasksManager { diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxUsersManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxUsersManager.java index 4c22729..c9257f2 100644 --- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxUsersManager.java +++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxUsersManager.java @@ -30,13 +30,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Box Users Manager - * - * <p> * Provides operations to manage Box users. - * - * - * */ public class BoxUsersManager { diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCollaborationsManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCollaborationsManagerEndpointConfiguration.java index 1fb0047..2265825 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCollaborationsManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCollaborationsManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxCollaborationsManager}. */ -@ApiParams(apiName = "collaborations", description = "Box Collaborations Manager Provides operations to manage Box collaborations", +@ApiParams(apiName = "collaborations", description = "Provides operations to manage Box collaborations", apiMethods = {@ApiMethod(methodName = "addFolderCollaboration", description="Add a collaboration to this folder"), @ApiMethod(methodName = "addFolderCollaborationByEmail", description="Add a collaboration to this folder"), @ApiMethod(methodName = "deleteCollaboration", description="Delete collaboration"), @ApiMethod(methodName = "getCollaborationInfo", description="Get collaboration information"), @ApiMethod(methodName = "getFolderCollaborations", description="Get information [...] @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCommentsManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCommentsManagerEndpointConfiguration.java index 476b30e..141ed02 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCommentsManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxCommentsManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxCommentsManager}. */ -@ApiParams(apiName = "comments", description = "Box Comments Manager", +@ApiParams(apiName = "comments", description = "Provides operations to manage Box comments", apiMethods = {@ApiMethod(methodName = "addFileComment", description="Add comment to file"), @ApiMethod(methodName = "changeCommentMessage", description="Change comment message"), @ApiMethod(methodName = "deleteComment", description="Delete comment"), @ApiMethod(methodName = "getCommentInfo", description="Get comment information"), @ApiMethod(methodName = "getFileComments", description="Get a list of any comments on this file"), @ApiMethod(methodName = "replyToComment", descrip [...] @UriParams @Configurer @@ -23,7 +23,7 @@ public final class BoxCommentsManagerEndpointConfiguration extends BoxConfigurat @ApiParam(apiMethods = {@ApiMethod(methodName = "changeCommentMessage", description="The id of comment to change"), @ApiMethod(methodName = "deleteComment", description="The id of comment to delete"), @ApiMethod(methodName = "getCommentInfo", description="The id of comment"), @ApiMethod(methodName = "replyToComment", description="The id of comment to reply to")}) private String commentId; @UriParam - @ApiParam(apiMethods = {@ApiMethod(methodName = "addFileComment", description="The id of file to rename"), @ApiMethod(methodName = "getFileComments", description="The id of file")}) + @ApiParam(apiMethods = {@ApiMethod(methodName = "addFileComment", description="The id of file"), @ApiMethod(methodName = "getFileComments", description="The id of file")}) private String fileId; @UriParam @ApiParam(apiMethods = {@ApiMethod(methodName = "addFileComment", description="The comment's message"), @ApiMethod(methodName = "changeCommentMessage", description="The new message for the comment"), @ApiMethod(methodName = "replyToComment", description="The message for the reply")}) diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventLogsManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventLogsManagerEndpointConfiguration.java index 11a5c6c..fa21ec3 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventLogsManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventLogsManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxEventLogsManager}. */ -@ApiParams(apiName = "event-logs", description = "Box Event Logs Manager", +@ApiParams(apiName = "event-logs", description = "Provides operations to read Box enterprise (admin) event logs", apiMethods = {@ApiMethod(methodName = "getEnterpriseEvents", description="Create an event stream with optional starting initial position and add listener that will be notified when an event is received")}) @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventsManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventsManagerEndpointConfiguration.java index 39c49ed..d841691 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventsManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxEventsManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxEventsManager}. */ -@ApiParams(apiName = "events", description = "Box Events Manager", +@ApiParams(apiName = "events", description = "Provides operations to manage Box events", apiMethods = {@ApiMethod(methodName = "listen", description="Create an event stream with optional starting initial position and add listener that will be notified when an event is received")}) @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java index d8aa379..62479df 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxFilesManager}. */ -@ApiParams(apiName = "files", description = "Box Files Manager", +@ApiParams(apiName = "files", description = "Provides operations to manage Box files", apiMethods = {@ApiMethod(methodName = "checkUpload", description="Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload"), @ApiMethod(methodName = "copyFile", description="Copy file to destination folder while optionally giving it a new name"), @ApiMethod(methodName = "createFileMetadata", description="Create metadata for file in either the global properties template or the specified template type"), @ApiMethod(metho [...] @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFoldersManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFoldersManagerEndpointConfiguration.java index f93a24a..9eea40a 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFoldersManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFoldersManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxFoldersManager}. */ -@ApiParams(apiName = "folders", description = "Box Folders Manager", +@ApiParams(apiName = "folders", description = "Provides operations to manage Box folders", apiMethods = {@ApiMethod(methodName = "copyFolder", description="Copy folder to destination folder while optionally giving it a new name"), @ApiMethod(methodName = "createFolder", description="Create a folder specified by path from parent folder with given parentFolderId, creating intermediate directories as required"), @ApiMethod(methodName = "createFolderSharedLink", description="Create a shared link to folder"), @ApiMethod(methodName = "deleteFolder", description="Delete fo [...] @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxGroupsManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxGroupsManagerEndpointConfiguration.java index 264431c..e8d962f 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxGroupsManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxGroupsManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxGroupsManager}. */ -@ApiParams(apiName = "groups", description = "Box Groups Manager", +@ApiParams(apiName = "groups", description = "Provides operations to manage Box groups", apiMethods = {@ApiMethod(methodName = "addGroupMembership", description="Add a member to group with the specified role"), @ApiMethod(methodName = "createGroup", description="Create a new group with a specified name and optional additional parameters"), @ApiMethod(methodName = "deleteGroup", description="Delete group"), @ApiMethod(methodName = "deleteGroupMembership", description="Delete group membership"), @ApiMethod(methodName = "getAllGroups", description="Get all the groups [...] @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxSearchManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxSearchManagerEndpointConfiguration.java index 10869bf..6b78c3c 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxSearchManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxSearchManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxSearchManager}. */ -@ApiParams(apiName = "search", description = "Box Search Manager", +@ApiParams(apiName = "search", description = "Provides operations to manage Box searches", apiMethods = {@ApiMethod(methodName = "searchFolder", description="Search folder and all descendant folders using the given query")}) @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxTasksManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxTasksManagerEndpointConfiguration.java index 12ed82e..7aead6a 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxTasksManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxTasksManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxTasksManager}. */ -@ApiParams(apiName = "tasks", description = "Box Tasks Manager", +@ApiParams(apiName = "tasks", description = "Provides operations to manage Box tasks", apiMethods = {@ApiMethod(methodName = "addAssignmentToTask", description="Add assignment for task"), @ApiMethod(methodName = "addFileTask", description="Add task to file"), @ApiMethod(methodName = "deleteTask", description="Delete task"), @ApiMethod(methodName = "deleteTaskAssignment", description="Delete task assignment"), @ApiMethod(methodName = "getFileTasks", description="Get a list of any tasks on file"), @ApiMethod(methodName = "getTaskAssignmentInfo", description="Get t [...] @UriParams @Configurer diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxUsersManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxUsersManagerEndpointConfiguration.java index ad2bddf..26f23e6 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxUsersManagerEndpointConfiguration.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxUsersManagerEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxUsersManager}. */ -@ApiParams(apiName = "users", description = "Box Users Manager", +@ApiParams(apiName = "users", description = "Provides operations to manage Box users", apiMethods = {@ApiMethod(methodName = "addUserEmailAlias", description="Add a new email alias to user's account"), @ApiMethod(methodName = "createAppUser", description="Provision a new app user in an enterprise with additional user information using Box Developer Edition"), @ApiMethod(methodName = "createEnterpriseUser", description="Provision a new user in an enterprise with additional user information"), @ApiMethod(methodName = "deleteUser", description="Delete user from an [...] @UriParams @Configurer
