This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 6c351b666764eccea7f8507c1412af173bbe34c3 Author: Claus Ibsen <[email protected]> AuthorDate: Mon Sep 7 09:32:00 2020 +0200 CAMEL-15478: camel-box uses javasource parser instead of javadoc for generating api component source code. --- components/camel-box/camel-box-api/pom.xml | 65 ++++++---------------- components/camel-box/camel-box-component/pom.xml | 64 +++++++++++---------- .../BoxEventLogsManagerEndpointConfiguration.java | 2 +- .../box/BoxFilesManagerEndpointConfiguration.java | 20 +++---- .../BoxFoldersManagerEndpointConfiguration.java | 12 ++-- .../box/BoxGroupsManagerEndpointConfiguration.java | 2 +- .../box/BoxTasksManagerEndpointConfiguration.java | 2 +- .../box/BoxUsersManagerEndpointConfiguration.java | 4 +- .../box/internal/BoxFilesManagerApiMethod.java | 2 +- .../org/apache/camel/component/box/box.json | 12 ++-- .../src/main/docs/box-component.adoc | 42 +++++++------- 11 files changed, 96 insertions(+), 131 deletions(-) diff --git a/components/camel-box/camel-box-api/pom.xml b/components/camel-box/camel-box-api/pom.xml index 00ad40b..09d740d 100644 --- a/components/camel-box/camel-box-api/pom.xml +++ b/components/camel-box/camel-box-api/pom.xml @@ -17,7 +17,8 @@ limitations under the License. --> -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> <modelVersion>4.0.0</modelVersion> @@ -41,65 +42,31 @@ </camel.osgi.import.pkg> </properties> - <build> - <defaultGoal>install</defaultGoal> + <dependencies> + <dependency> + <groupId>com.box</groupId> + <artifactId>box-java-sdk</artifactId> + <version>${box-java-sdk-version}</version> + </dependency> + </dependencies> + <build> <plugins> - - <!-- to generate API Javadoc --> <plugin> - <groupId>org.apache.camel</groupId> - <artifactId>camel-javadoc-plugin</artifactId> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-source-plugin</artifactId> + <version>3.2.1</version> <executions> <execution> - <id>add-javadoc</id> - <phase>generate-test-resources</phase> + <id>attach-sources</id> + <phase>verify</phase> <goals> - <goal>jar</goal> + <goal>jar-no-fork</goal> </goals> - <configuration> - <attach>true</attach> - <source>${jdk.version}</source> - <quiet>true</quiet> - <detectOfflineLinks>false</detectOfflineLinks> - <javadocVersion>1.8.0</javadocVersion> - <encoding>UTF-8</encoding> - <doclint>none</doclint> - <locale>en</locale> - </configuration> </execution> </executions> </plugin> - </plugins> </build> - <!-- Disable Java 8 doclint checks to avoid Javadoc plugin failures --> - <profiles> - <profile> - <id>doclint-java8-disable</id> - <activation> - <jdk>[1.8,</jdk> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <configuration> - <additionalparam>-Xdoclint:none</additionalparam> - </configuration> - </plugin> - </plugins> - </build> - </profile> - </profiles> - - <dependencies> - <dependency> - <groupId>com.box</groupId> - <artifactId>box-java-sdk</artifactId> - <version>${box-java-sdk-version}</version> - </dependency> - </dependencies> </project> diff --git a/components/camel-box/camel-box-component/pom.xml b/components/camel-box/camel-box-component/pom.xml index 31016b5..2fbdf18 100644 --- a/components/camel-box/camel-box-component/pom.xml +++ b/components/camel-box/camel-box-component/pom.xml @@ -70,24 +70,6 @@ <version>${jsoup-version}</version> </dependency> - <!-- Component API javadoc in provided scope to read API signatures --> - <dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-box-api</artifactId> - <version>${project.version}</version> - <type>javadoc</type> - <scope>provided</scope> - </dependency> - - <!-- Component API javadoc in provided scope to read API signatures --> - <dependency> - <groupId>com.box</groupId> - <artifactId>box-java-sdk</artifactId> - <version>${box-java-sdk-version}</version> - <type>javadoc</type> - <scope>provided</scope> - </dependency> - <!-- logging --> <dependency> <groupId>org.slf4j</groupId> @@ -136,7 +118,7 @@ <api> <apiName>collaborations</apiName> <proxyClass>org.apache.camel.component.box.api.BoxCollaborationsManager</proxyClass> - <fromJavadoc /> + <fromJavasource /> <aliases> <alias> <methodPattern>addFolderCollaboration</methodPattern> @@ -171,7 +153,7 @@ <api> <apiName>comments</apiName> <proxyClass>org.apache.camel.component.box.api.BoxCommentsManager</proxyClass> - <fromJavadoc /> + <fromJavasource /> <aliases> <alias> <methodPattern>addFileComment</methodPattern> @@ -202,7 +184,7 @@ <api> <apiName>event-logs</apiName> <proxyClass>org.apache.camel.component.box.api.BoxEventLogsManager</proxyClass> - <fromJavadoc /> + <fromJavasource /> <aliases> <alias> <methodPattern>getEnterpriseEvents</methodPattern> @@ -217,7 +199,7 @@ <api> <apiName>files</apiName> <proxyClass>org.apache.camel.component.box.api.BoxFilesManager</proxyClass> - <fromJavadoc /> + <fromJavasource /> <aliases> <alias> <methodPattern>uploadFile</methodPattern> @@ -328,8 +310,8 @@ <api> <apiName>folders</apiName> <proxyClass>org.apache.camel.component.box.api.BoxFoldersManager</proxyClass> - <fromJavadoc> - </fromJavadoc> + <fromJavasource> + </fromJavasource> <aliases> <alias> <methodPattern>getRootFolder</methodPattern> @@ -385,8 +367,8 @@ <api> <apiName>groups</apiName> <proxyClass>org.apache.camel.component.box.api.BoxGroupsManager</proxyClass> - <fromJavadoc> - </fromJavadoc> + <fromJavasource> + </fromJavasource> <aliases> <alias> <methodPattern>createGroup</methodPattern> @@ -437,9 +419,9 @@ <api> <apiName>events</apiName> <proxyClass>org.apache.camel.component.box.api.BoxEventsManager</proxyClass> - <fromJavadoc> + <fromJavasource> <excludeMethods>stopListening</excludeMethods> - </fromJavadoc> + </fromJavasource> <excludeConfigNames>listener</excludeConfigNames> <nullableOptions> <nullableOption>startingPosition</nullableOption> @@ -448,7 +430,7 @@ <api> <apiName>search</apiName> <proxyClass>org.apache.camel.component.box.api.BoxSearchManager</proxyClass> - <fromJavadoc /> + <fromJavasource /> <aliases> <alias> <methodPattern>searchFolder</methodPattern> @@ -459,8 +441,8 @@ <api> <apiName>tasks</apiName> <proxyClass>org.apache.camel.component.box.api.BoxTasksManager</proxyClass> - <fromJavadoc> - </fromJavadoc> + <fromJavasource> + </fromJavasource> <aliases> <alias> <methodPattern>addFileTask</methodPattern> @@ -506,7 +488,7 @@ <api> <apiName>users</apiName> <proxyClass>org.apache.camel.component.box.api.BoxUsersManager</proxyClass> - <fromJavadoc /> + <fromJavasource /> <aliases> <alias> <methodPattern>getCurrentUser</methodPattern> @@ -561,11 +543,27 @@ <excludeConfigNames /> <excludeConfigTypes /> <extraOptions> - <fromJavadoc /> + <fromJavasource /> <aliases /> --> </configuration> </execution> </executions> + <dependencies> + <!-- Component API javadoc in provided scope to read API signatures --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-box-api</artifactId> + <version>${project.version}</version> + <classifier>sources</classifier> + </dependency> + <!-- Component API javadoc in provided scope to read API signatures --> + <dependency> + <groupId>com.box</groupId> + <artifactId>box-java-sdk</artifactId> + <version>${box-java-sdk-version}</version> + <classifier>sources</classifier> + </dependency> + </dependencies> </plugin> <plugin> <!-- we need to generate additional configurer classes --> 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 1d7a7c1..9afe659 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 @@ -20,7 +20,7 @@ public final class BoxEventLogsManagerEndpointConfiguration extends BoxConfigura private java.util.Date after; @UriParam(description = "The upper bound on the timestamp of the events returned") private java.util.Date before; - @UriParam(description = "The starting position of the event stream. May be") + @UriParam(description = "The starting position of the event stream. May be null in which case all events within bounds returned.") private String position; @UriParam(description = "An optional list of event types to filter by") private com.box.sdk.BoxEvent.Type[] types; 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 b6c0c69..ff8cbdd 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 @@ -26,7 +26,7 @@ public final class BoxFilesManagerEndpointConfiguration extends BoxConfiguration private java.util.Date created; @UriParam(description = "The id of the destination folder") private String destinationFolderId; - @UriParam(description = "The information fields to retrieve; if") + @UriParam(description = "The information fields to retrieve; if null all information fields are retrieved.") private String[] fields; @UriParam(description = "A stream containing contents of the file to upload") private java.io.InputStream fileContent; @@ -40,7 +40,7 @@ public final class BoxFilesManagerEndpointConfiguration extends BoxConfiguration private com.box.sdk.BoxFile.ThumbnailFileType fileType; @UriParam(description = "The updated information") private com.box.sdk.BoxFile.Info info; - @UriParam(description = "A listener for monitoring the download's progress; if") + @UriParam(description = "A listener for monitoring the download's progress; if null the download's progress will not be monitored.") private com.box.sdk.ProgressListener listener; @UriParam(description = "Maximum height") private Integer maxHeight; @@ -56,25 +56,25 @@ public final class BoxFilesManagerEndpointConfiguration extends BoxConfiguration private java.util.Date modified; @UriParam(description = "The new name of file") private String newFileName; - @UriParam(description = "Is") + @UriParam(description = "The new name for copied file; if newName is null, the copied file has same name as the original.") private String newName; @UriParam(description = "The stream to which the file contents will be written") private java.io.OutputStream output; @UriParam(description = "The id of parent folder") private String parentFolderId; - @UriParam(description = "Is") + @UriParam(description = "The permissions of the created link; if permissions is null then the created shared link is create with default permissions.") private com.box.sdk.BoxSharedLink.Permissions permissions; - @UriParam(description = "The byte offset in file at which to stop the download; if") + @UriParam(description = "The byte offset in file at which to stop the download; if null the entire contents of file will be downloaded.") private Long rangeEnd; - @UriParam(description = "The byte offset in file at which to start the download; if") + @UriParam(description = "The byte offset in file at which to start the download; if null the entire contents of file will be downloaded.") private Long rangeStart; - @UriParam(description = "The size of the file's content used for monitoring the upload's progress.Skip navigation links") + @UriParam(description = "The size of the file's content used for monitoring the upload's progress") private Long size; - @UriParam(description = "The metadata template type name; if") + @UriParam(description = "The metadata template type name; if null the global properties template type is used.") private String typeName; - @UriParam(description = "The date and time at which time the created shared link will expire; if") + @UriParam(description = "The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created.") private java.util.Date unshareDate; - @UriParam(description = "The version of file to delete; initial version of file has value of") + @UriParam(description = "The version of file to delete; initial version of file has value of 0, second version of file is 1 and so on.") private Integer version; public com.box.sdk.BoxSharedLink.Access getAccess() { 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 76e103b..e2e42f0 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 @@ -20,7 +20,7 @@ public final class BoxFoldersManagerEndpointConfiguration extends BoxConfigurati private com.box.sdk.BoxSharedLink.Access access; @UriParam(description = "The id of the destination folder") private String destinationFolderId; - @UriParam(description = "The information fields to retrieve; if") + @UriParam(description = "The information fields to retrieve; if null all information fields are retrieved.") private String[] fields; @UriParam(description = "The id of folder to copy") private String folderId; @@ -28,21 +28,21 @@ public final class BoxFoldersManagerEndpointConfiguration extends BoxConfigurati private String folderName; @UriParam(description = "The updated information") private com.box.sdk.BoxFolder.Info info; - @UriParam(description = "The maximum number of children to retrieve after the offset; if") + @UriParam(description = "The maximum number of children to retrieve after the offset; if null all child items are retrieved.") private Long limit; @UriParam(description = "The new name of folder") private String newFolderName; - @UriParam(description = "Is") + @UriParam(description = "The new name for copied folder; if newName is null, the copied folder has same name as the original.") private String newName; - @UriParam(description = "The index of first child item to retrieve; if") + @UriParam(description = "The index of first child item to retrieve; if null all child items are retrieved.") private Long offset; @UriParam(description = "The id of parent folder") private String parentFolderId; @UriParam(description = "Sequence of Box folder names from parent folder to returned folder") private String[] path; - @UriParam(description = "Is") + @UriParam(description = "The permissions of the created link; if permissions is null then the created shared link is create with default permissions.") private com.box.sdk.BoxSharedLink.Permissions permissions; - @UriParam(description = "The date and time at which time the created shared link will expire; if") + @UriParam(description = "The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created.") private java.util.Date unshareDate; public com.box.sdk.BoxSharedLink.Access getAccess() { 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 9d3f4c8..4b1df19 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 @@ -36,7 +36,7 @@ public final class BoxGroupsManagerEndpointConfiguration extends BoxConfiguratio private String name; @UriParam(description = "The provenance of the new group") private String provenance; - @UriParam(description = "The role of the user in this group. Can be") + @UriParam(description = "The role of the user in this group. Can be null to assign the default role.") private com.box.sdk.BoxGroupMembership.Role role; @UriParam(description = "The id of user to be added to group") private String userId; 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 96e2a98..5cc52f5 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 @@ -28,7 +28,7 @@ public final class BoxTasksManagerEndpointConfiguration extends BoxConfiguration private com.box.sdk.BoxTask.Info info; @UriParam(description = "An optional message to include with the task") private String message; - @UriParam(description = "The id of task assignment to delete.Skip navigation links") + @UriParam(description = "The id of task assignment to delete") private String taskAssignmentId; @UriParam(description = "The id of task to add assignment for") private String taskId; 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 4245614..707f343 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 @@ -22,7 +22,7 @@ public final class BoxUsersManagerEndpointConfiguration extends BoxConfiguration private String emailAliasId; @UriParam(description = "The fields to retrieve. Leave this out for the standard fields.") private String[] fields; - @UriParam(description = "The filter term to lookup users by (login for external, login or name for managed); if") + @UriParam(description = "The filter term to lookup users by (login for external, login or name for managed); if null all managed users are returned.") private String filterTerm; @UriParam(description = "Whether or not this user should be deleted even if they still own files") private Boolean force; @@ -36,7 +36,7 @@ public final class BoxUsersManagerEndpointConfiguration extends BoxConfiguration private Boolean notifyUser; @UriParam(description = "Additional user information") private com.box.sdk.CreateUserParams params; - @UriParam(description = "The user id of the user whose files will be the source for this operation.Skip navigation links") + @UriParam(description = "The user id of the user whose files will be the source for this operation") private String sourceUserId; @UriParam(description = "The id of user") private String userId; diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/internal/BoxFilesManagerApiMethod.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/internal/BoxFilesManagerApiMethod.java index 2fdd88e..06da5ce 100644 --- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/internal/BoxFilesManagerApiMethod.java +++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/internal/BoxFilesManagerApiMethod.java @@ -105,7 +105,7 @@ public enum BoxFilesManagerApiMethod implements ApiMethod { arg("fileId", String.class)), GET_FILE_THUMBNAIL( - new byte[0].getClass(), + byte.class, "getFileThumbnail", arg("fileId", String.class), arg("fileType", com.box.sdk.BoxFile.ThumbnailFileType.class), diff --git a/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json b/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json index e899d33..492364f 100644 --- a/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json +++ b/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json @@ -88,13 +88,13 @@ "apiProperties": { "collaborations": { "collaborationId": { "kind": "parameter", "displayName": "Collaboration Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id of comment to change" }, "collaborator": { "kind": "parameter", "displayName": "Collaborator", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxCollaborator", "deprecated": false, " [...] "comments": { "commentId": { "kind": "parameter", "displayName": "Comment Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id of comment to change" }, "fileId": { "kind": "parameter", "displayName": "File Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id o [...] - "event-logs": { "after": { "kind": "parameter", "displayName": "After", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "secret": false, "description": "The lower bound on the timestamp of the events returned" }, "before": { "kind": "parameter", "displayName": "Before", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "secret": false, "descrip [...] + "event-logs": { "after": { "kind": "parameter", "displayName": "After", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "secret": false, "description": "The lower bound on the timestamp of the events returned" }, "before": { "kind": "parameter", "displayName": "Before", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "secret": false, "descrip [...] "events": { "startingPosition": { "kind": "parameter", "displayName": "Starting Position", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "secret": false, "description": "The starting position of the event stream" } }, - "files": { "access": { "kind": "parameter", "displayName": "Access", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxSharedLink.Access", "enum": [ "DEFAULT", "OPEN", "COMPANY", "COLLABORATORS" ], "deprecated": false, "secret": false, "description": "The access level of the shared link" }, "check": { "kind": "parameter", "displayName": "Check", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang. [...] - "folders": { "access": { "kind": "parameter", "displayName": "Access", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxSharedLink.Access", "enum": [ "DEFAULT", "OPEN", "COMPANY", "COLLABORATORS" ], "deprecated": false, "secret": false, "description": "The access level of the shared link" }, "destinationFolderId": { "kind": "parameter", "displayName": "Destination Folder Id", "group": "common", "label": "", "required": false, "type": "s [...] - "groups": { "description": { "kind": "parameter", "displayName": "Description", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The description of the new group" }, "externalSyncIdentifier": { "kind": "parameter", "displayName": "External Sync Identifier", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "s [...] + "files": { "access": { "kind": "parameter", "displayName": "Access", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxSharedLink.Access", "enum": [ "DEFAULT", "OPEN", "COMPANY", "COLLABORATORS" ], "deprecated": false, "secret": false, "description": "The access level of the shared link" }, "check": { "kind": "parameter", "displayName": "Check", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "java.lang. [...] + "folders": { "access": { "kind": "parameter", "displayName": "Access", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxSharedLink.Access", "enum": [ "DEFAULT", "OPEN", "COMPANY", "COLLABORATORS" ], "deprecated": false, "secret": false, "description": "The access level of the shared link" }, "destinationFolderId": { "kind": "parameter", "displayName": "Destination Folder Id", "group": "common", "label": "", "required": false, "type": "s [...] + "groups": { "description": { "kind": "parameter", "displayName": "Description", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The description of the new group" }, "externalSyncIdentifier": { "kind": "parameter", "displayName": "External Sync Identifier", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "s [...] "search": { "folderId": { "kind": "parameter", "displayName": "Folder Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id of folder searched" }, "query": { "kind": "parameter", "displayName": "Query", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The search query" } }, - "tasks": { "action": { "kind": "parameter", "displayName": "Action", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxTask.Action", "enum": [ "REVIEW", "COMPLETE" ], "deprecated": false, "secret": false, "description": "The action the task assignee will be prompted to do" }, "assignTo": { "kind": "parameter", "displayName": "Assign To", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxUser [...] - "users": { "email": { "kind": "parameter", "displayName": "Email", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The email address to add as an alias" }, "emailAliasId": { "kind": "parameter", "displayName": "Email Alias Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": [...] + "tasks": { "action": { "kind": "parameter", "displayName": "Action", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxTask.Action", "enum": [ "REVIEW", "COMPLETE" ], "deprecated": false, "secret": false, "description": "The action the task assignee will be prompted to do" }, "assignTo": { "kind": "parameter", "displayName": "Assign To", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.box.sdk.BoxUser [...] + "users": { "email": { "kind": "parameter", "displayName": "Email", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The email address to add as an alias" }, "emailAliasId": { "kind": "parameter", "displayName": "Email Alias Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": [...] } } diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc index d2ed8ab..83a771c 100644 --- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc +++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc @@ -198,7 +198,7 @@ The following lists each API name and method and its additional parameters. | Name | Description | Type | *after* | The lower bound on the timestamp of the events returned | Date | *before* | The upper bound on the timestamp of the events returned | Date -| *position* | The starting position of the event stream. May be | String +| *position* | The starting position of the event stream. May be null in which case all events within bounds returned. | String | *types* | An optional list of event types to filter by | Type[] |=== @@ -222,14 +222,14 @@ The following lists each API name and method and its additional parameters. | *content* | A stream containing contents of the file to upload | InputStream | *created* | The content created date that will be given to the uploaded file | Date | *destinationFolderId* | The id of the destination folder | String -| *fields* | The information fields to retrieve; if | String[] +| *fields* | The information fields to retrieve; if null all information fields are retrieved. | String[] | *fileContent* | A stream containing contents of the file to upload | InputStream | *fileId* | The id of file to copy | String | *fileName* | The name to give the uploaded file | String | *fileSize* | The size of the file's content used for monitoring the upload's progress | Long | *fileType* | Either PNG of JPG | ThumbnailFileType | *info* | The updated information | Info -| *listener* | A listener for monitoring the download's progress; if | ProgressListener +| *listener* | A listener for monitoring the download's progress; if null the download's progress will not be monitored. | ProgressListener | *maxHeight* | Maximum height | Integer | *maxWidth* | Maximum width | Integer | *metadata* | The new metadata values | Metadata @@ -237,16 +237,16 @@ The following lists each API name and method and its additional parameters. | *minWidth* | Minimum width | Integer | *modified* | The content modified date that will be given to the uploaded file | Date | *newFileName* | The new name of file | String -| *newName* | Is | String +| *newName* | The new name for copied file; if newName is null, the copied file has same name as the original. | String | *output* | The stream to which the file contents will be written | OutputStream | *parentFolderId* | The id of parent folder | String -| *permissions* | Is | Permissions -| *rangeEnd* | The byte offset in file at which to stop the download; if | Long -| *rangeStart* | The byte offset in file at which to start the download; if | Long -| *size* | The size of the file's content used for monitoring the upload's progress.Skip navigation links | Long -| *typeName* | The metadata template type name; if | String -| *unshareDate* | The date and time at which time the created shared link will expire; if | Date -| *version* | The version of file to delete; initial version of file has value of | Integer +| *permissions* | The permissions of the created link; if permissions is null then the created shared link is create with default permissions. | Permissions +| *rangeEnd* | The byte offset in file at which to stop the download; if null the entire contents of file will be downloaded. | Long +| *rangeStart* | The byte offset in file at which to start the download; if null the entire contents of file will be downloaded. | Long +| *size* | The size of the file's content used for monitoring the upload's progress | Long +| *typeName* | The metadata template type name; if null the global properties template type is used. | String +| *unshareDate* | The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created. | Date +| *version* | The version of file to delete; initial version of file has value of 0, second version of file is 1 and so on. | Integer |=== @@ -257,18 +257,18 @@ The following lists each API name and method and its additional parameters. | Name | Description | Type | *access* | The access level of the shared link | Access | *destinationFolderId* | The id of the destination folder | String -| *fields* | The information fields to retrieve; if | String[] +| *fields* | The information fields to retrieve; if null all information fields are retrieved. | String[] | *folderId* | The id of folder to copy | String | *folderName* | The name of created folder | String | *info* | The updated information | Info -| *limit* | The maximum number of children to retrieve after the offset; if | Long +| *limit* | The maximum number of children to retrieve after the offset; if null all child items are retrieved. | Long | *newFolderName* | The new name of folder | String -| *newName* | Is | String -| *offset* | The index of first child item to retrieve; if | Long +| *newName* | The new name for copied folder; if newName is null, the copied folder has same name as the original. | String +| *offset* | The index of first child item to retrieve; if null all child items are retrieved. | Long | *parentFolderId* | The id of parent folder | String | *path* | Sequence of Box folder names from parent folder to returned folder | String[] -| *permissions* | Is | Permissions -| *unshareDate* | The date and time at which time the created shared link will expire; if | Date +| *permissions* | The permissions of the created link; if permissions is null then the created shared link is create with default permissions. | Permissions +| *unshareDate* | The date and time at which time the created shared link will expire; if unsharedDate is null then a non-expiring link is created. | Date |=== @@ -287,7 +287,7 @@ The following lists each API name and method and its additional parameters. | *memberViewabilityLevel* | The member_viewability_level of the new group | String | *name* | The name of the new group | String | *provenance* | The provenance of the new group | String -| *role* | The role of the user in this group. Can be | Role +| *role* | The role of the user in this group. Can be null to assign the default role. | Role | *userId* | The id of user to be added to group | String |=== @@ -313,7 +313,7 @@ The following lists each API name and method and its additional parameters. | *fileId* | The id of file to add task to | String | *info* | The updated information | Info | *message* | An optional message to include with the task | String -| *taskAssignmentId* | The id of task assignment to delete.Skip navigation links | String +| *taskAssignmentId* | The id of task assignment to delete | String | *taskId* | The id of task to add assignment for | String |=== @@ -326,14 +326,14 @@ The following lists each API name and method and its additional parameters. | *email* | The email address to add as an alias | String | *emailAliasId* | The id of the email alias to delete | String | *fields* | The fields to retrieve. Leave this out for the standard fields. | String[] -| *filterTerm* | The filter term to lookup users by (login for external, login or name for managed); if | String +| *filterTerm* | The filter term to lookup users by (login for external, login or name for managed); if null all managed users are returned. | String | *force* | Whether or not this user should be deleted even if they still own files | Boolean | *info* | The updated information | Info | *login* | The email address the user will use to login | String | *name* | The name of the user | String | *notifyUser* | Whether or not to send an email notification to the user that their account has been deleted | Boolean | *params* | Additional user information | CreateUserParams -| *sourceUserId* | The user id of the user whose files will be the source for this operation.Skip navigation links | String +| *sourceUserId* | The user id of the user whose files will be the source for this operation | String | *userId* | The id of user | String |=== // endpoint options: END
