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
The following commit(s) were added to refs/heads/master by this push:
new a35d8e8 CAMEL-15478: Polished zendesk api docs
a35d8e8 is described below
commit a35d8e8582ce8dd8d824cf52a3ec73e7a7cfa4d4
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Sep 18 09:17:32 2020 +0200
CAMEL-15478: Polished zendesk api docs
---
.../org/apache/camel/catalog/docs/zendesk-component.adoc | 10 +++++-----
.../camel/component/zendesk/ZendeskEndpointConfiguration.java | 2 +-
.../resources/org/apache/camel/component/zendesk/zendesk.json | 2 +-
components/camel-zendesk/src/main/docs/zendesk-component.adoc | 10 +++++-----
docs/components/modules/ROOT/pages/zendesk-component.adoc | 10 +++++-----
.../src/main/java/org/apache/camel/maven/JavaSourceParser.java | 7 +++++++
6 files changed, 24 insertions(+), 17 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/zendesk-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/zendesk-component.adoc
index d4d1679..956050e 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/zendesk-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/zendesk-component.adoc
@@ -785,8 +785,8 @@ The 221 method(s) is listed in the table below.
| *createOrUpdateUsersAsync* | |
| *createOrganization* | |
| *createOrganizationMembership* | |
-| *createOrganizationMemberships* | | Https://developer
-| *createOrganizationMembershipsAsync* | | Https://developer
+| *createOrganizationMemberships* | |
+| *createOrganizationMembershipsAsync* | |
| *createOrganizations* | |
| *createOrganizationsAsync* | |
| *createPermissionGroup* | | Create permission group
@@ -823,7 +823,7 @@ The 221 method(s) is listed in the table below.
| *deleteGroupMembership* | |
| *deleteOrganization* | |
| *deleteOrganizationMembership* | |
-| *deleteOrganizationMemberships* | | Https://developer
+| *deleteOrganizationMemberships* | |
| *deletePermissionGroup* | | Delete permission group
| *deleteSection* | |
| *deleteSuspendedTicket* | |
@@ -855,7 +855,7 @@ The 221 method(s) is listed in the table below.
| *getCategory* | |
| *getCategoryTranslations* | |
| *getComplianceDeletionStatuses* | |
-| *getDeletedTickets* | | Https://developer
+| *getDeletedTickets* | |
| *getDynamicContentItem* | |
| *getDynamicContentItemVariant* | |
| *getDynamicContentItemVariants* | |
@@ -908,7 +908,7 @@ The 221 method(s) is listed in the table below.
| *getTickets* | |
| *getTicketsByExternalId* | |
| *getTicketsFromSearch* | |
-| *getTicketsIncrementally* | | Https://developer
+| *getTicketsIncrementally* | |
| *getTopic* | |
| *getTopics* | | List Topics using a User Segment
| *getTopicsByUser* | |
diff --git
a/components/camel-zendesk/src/generated/java/org/apache/camel/component/zendesk/ZendeskEndpointConfiguration.java
b/components/camel-zendesk/src/generated/java/org/apache/camel/component/zendesk/ZendeskEndpointConfiguration.java
index e329b46..8f6c72d 100644
---
a/components/camel-zendesk/src/generated/java/org/apache/camel/component/zendesk/ZendeskEndpointConfiguration.java
+++
b/components/camel-zendesk/src/generated/java/org/apache/camel/component/zendesk/ZendeskEndpointConfiguration.java
@@ -15,7 +15,7 @@ import org.apache.camel.spi.UriParams;
* Camel endpoint configuration for {@link org.zendesk.client.v2.Zendesk}.
*/
@ApiParams(apiName = "DEFAULT", description = "",
- apiMethods = {@ApiMethod(methodName = "addTagToOrganisations",
signatures={"java.util.List<String> addTagToOrganisations(long id, String[]
tags)"}), @ApiMethod(methodName = "addTagToTicket",
signatures={"java.util.List<String> addTagToTicket(long id, String[] tags)"}),
@ApiMethod(methodName = "addTagToTopics", signatures={"java.util.List<String>
addTagToTopics(long id, String[] tags)"}), @ApiMethod(methodName =
"associateAttachmentsToArticle", signatures={"void associateAttach [...]
+ apiMethods = {@ApiMethod(methodName = "addTagToOrganisations",
signatures={"java.util.List<String> addTagToOrganisations(long id, String[]
tags)"}), @ApiMethod(methodName = "addTagToTicket",
signatures={"java.util.List<String> addTagToTicket(long id, String[] tags)"}),
@ApiMethod(methodName = "addTagToTopics", signatures={"java.util.List<String>
addTagToTopics(long id, String[] tags)"}), @ApiMethod(methodName =
"associateAttachmentsToArticle", signatures={"void associateAttach [...]
@UriParams
@Configurer
public final class ZendeskEndpointConfiguration extends ZendeskConfiguration {
diff --git
a/components/camel-zendesk/src/generated/resources/org/apache/camel/component/zendesk/zendesk.json
b/components/camel-zendesk/src/generated/resources/org/apache/camel/component/zendesk/zendesk.json
index f48589b..aeb3dda 100644
---
a/components/camel-zendesk/src/generated/resources/org/apache/camel/component/zendesk/zendesk.json
+++
b/components/camel-zendesk/src/generated/resources/org/apache/camel/component/zendesk/zendesk.json
@@ -66,7 +66,7 @@
"username": { "kind": "parameter", "displayName": "Username", "group":
"security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": true,
"configurationClass":
"org.apache.camel.component.zendesk.ZendeskConfiguration",
"configurationField": "configuration", "description": "The user name." }
},
"apis": {
- "DEFAULT": { "methods": { "addTagToOrganisations": { "description": "",
"signatures": [ "java.util.List<String> addTagToOrganisations(long id, String[]
tags)" ] }, "addTagToTicket": { "description": "", "signatures": [
"java.util.List<String> addTagToTicket(long id, String[] tags)" ] },
"addTagToTopics": { "description": "", "signatures": [ "java.util.List<String>
addTagToTopics(long id, String[] tags)" ] }, "associateAttachmentsToArticle": {
"description": "", "signatures": [ "void [...]
+ "DEFAULT": { "methods": { "addTagToOrganisations": { "description": "",
"signatures": [ "java.util.List<String> addTagToOrganisations(long id, String[]
tags)" ] }, "addTagToTicket": { "description": "", "signatures": [
"java.util.List<String> addTagToTicket(long id, String[] tags)" ] },
"addTagToTopics": { "description": "", "signatures": [ "java.util.List<String>
addTagToTopics(long id, String[] tags)" ] }, "associateAttachmentsToArticle": {
"description": "", "signatures": [ "void [...]
},
"apiProperties": {
"DEFAULT": { "methods": { "addTagToOrganisations": { "properties": { "id":
{ "kind": "parameter", "displayName": "Id", "group": "common", "label": "",
"required": false, "type": "integer", "javaType": "java.lang.Long",
"deprecated": false, "secret": false, "description": "", "optional": false },
"tags": { "kind": "parameter", "displayName": "Tags", "group": "common",
"label": "", "required": false, "type": "array", "javaType":
"java.lang.String[]", "deprecated": false, "secret": fals [...]
diff --git a/components/camel-zendesk/src/main/docs/zendesk-component.adoc
b/components/camel-zendesk/src/main/docs/zendesk-component.adoc
index d4d1679..956050e 100644
--- a/components/camel-zendesk/src/main/docs/zendesk-component.adoc
+++ b/components/camel-zendesk/src/main/docs/zendesk-component.adoc
@@ -785,8 +785,8 @@ The 221 method(s) is listed in the table below.
| *createOrUpdateUsersAsync* | |
| *createOrganization* | |
| *createOrganizationMembership* | |
-| *createOrganizationMemberships* | | Https://developer
-| *createOrganizationMembershipsAsync* | | Https://developer
+| *createOrganizationMemberships* | |
+| *createOrganizationMembershipsAsync* | |
| *createOrganizations* | |
| *createOrganizationsAsync* | |
| *createPermissionGroup* | | Create permission group
@@ -823,7 +823,7 @@ The 221 method(s) is listed in the table below.
| *deleteGroupMembership* | |
| *deleteOrganization* | |
| *deleteOrganizationMembership* | |
-| *deleteOrganizationMemberships* | | Https://developer
+| *deleteOrganizationMemberships* | |
| *deletePermissionGroup* | | Delete permission group
| *deleteSection* | |
| *deleteSuspendedTicket* | |
@@ -855,7 +855,7 @@ The 221 method(s) is listed in the table below.
| *getCategory* | |
| *getCategoryTranslations* | |
| *getComplianceDeletionStatuses* | |
-| *getDeletedTickets* | | Https://developer
+| *getDeletedTickets* | |
| *getDynamicContentItem* | |
| *getDynamicContentItemVariant* | |
| *getDynamicContentItemVariants* | |
@@ -908,7 +908,7 @@ The 221 method(s) is listed in the table below.
| *getTickets* | |
| *getTicketsByExternalId* | |
| *getTicketsFromSearch* | |
-| *getTicketsIncrementally* | | Https://developer
+| *getTicketsIncrementally* | |
| *getTopic* | |
| *getTopics* | | List Topics using a User Segment
| *getTopicsByUser* | |
diff --git a/docs/components/modules/ROOT/pages/zendesk-component.adoc
b/docs/components/modules/ROOT/pages/zendesk-component.adoc
index e839366..b51cdc7 100644
--- a/docs/components/modules/ROOT/pages/zendesk-component.adoc
+++ b/docs/components/modules/ROOT/pages/zendesk-component.adoc
@@ -787,8 +787,8 @@ The 221 method(s) is listed in the table below.
| *createOrUpdateUsersAsync* | |
| *createOrganization* | |
| *createOrganizationMembership* | |
-| *createOrganizationMemberships* | | Https://developer
-| *createOrganizationMembershipsAsync* | | Https://developer
+| *createOrganizationMemberships* | |
+| *createOrganizationMembershipsAsync* | |
| *createOrganizations* | |
| *createOrganizationsAsync* | |
| *createPermissionGroup* | | Create permission group
@@ -825,7 +825,7 @@ The 221 method(s) is listed in the table below.
| *deleteGroupMembership* | |
| *deleteOrganization* | |
| *deleteOrganizationMembership* | |
-| *deleteOrganizationMemberships* | | Https://developer
+| *deleteOrganizationMemberships* | |
| *deletePermissionGroup* | | Delete permission group
| *deleteSection* | |
| *deleteSuspendedTicket* | |
@@ -857,7 +857,7 @@ The 221 method(s) is listed in the table below.
| *getCategory* | |
| *getCategoryTranslations* | |
| *getComplianceDeletionStatuses* | |
-| *getDeletedTickets* | | Https://developer
+| *getDeletedTickets* | |
| *getDynamicContentItem* | |
| *getDynamicContentItemVariant* | |
| *getDynamicContentItemVariants* | |
@@ -910,7 +910,7 @@ The 221 method(s) is listed in the table below.
| *getTickets* | |
| *getTicketsByExternalId* | |
| *getTicketsFromSearch* | |
-| *getTicketsIncrementally* | | Https://developer
+| *getTicketsIncrementally* | |
| *getTopic* | |
| *getTopics* | | List Topics using a User Segment
| *getTopicsByUser* | |
diff --git
a/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/JavaSourceParser.java
b/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/JavaSourceParser.java
index b351636..c71d494 100644
---
a/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/JavaSourceParser.java
+++
b/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/JavaSourceParser.java
@@ -391,7 +391,14 @@ public class JavaSourceParser {
desc = desc.substring(0, desc.length() - 1);
desc = desc.trim();
}
+
desc = sanitizeDescription(desc, summary);
+
+ // skip if its just a http link (such as seen in zendesk client)
+ if (desc != null && desc.matches("https?:.*")) {
+ return null;
+ }
+
if (desc != null && !desc.isEmpty()) {
// upper case first letter
char ch = desc.charAt(0);
