You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2020/09/15 15:56:58 UTC
[camel] 09/22: CAMEL-15478: api-component should generate @ApiParam
with more fine grained details so we know which parameter is for which api
method.
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 72c53d52801a5f0cf41bf122cd420ded341603c6
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Mon Sep 14 10:28:52 2020 +0200
CAMEL-15478: api-component should generate @ApiParam with more fine grained details so we know which parameter is for which api method.
---
.../camel/component/as2/AS2ClientManagerEndpointConfiguration.java | 2 +-
.../camel/component/as2/AS2ServerManagerEndpointConfiguration.java | 2 +-
.../apache/camel/component/fhir/FhirCreateEndpointConfiguration.java | 2 +-
.../apache/camel/component/fhir/FhirPatchEndpointConfiguration.java | 2 +-
.../apache/camel/component/fhir/FhirReadEndpointConfiguration.java | 2 +-
.../apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java | 2 +-
.../camel/component/fhir/FhirValidateEndpointConfiguration.java | 2 +-
.../apache/camel/component/zendesk/ZendeskEndpointConfiguration.java | 4 ++--
8 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java b/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java
index 2d13f50..1631ee9 100644
--- a/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java
+++ b/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.as2.api.AS2ClientManager}.
*/
-@ApiParams(apiName = "client", description = "Sends EDI Messages over HTTP /",
+@ApiParams(apiName = "client", description = "Sends EDI Messages over HTTP",
apiMethods = {@ApiMethod(methodName = "send", description="Send ediMessage to trading partner")})
@UriParams
@Configurer
diff --git a/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ServerManagerEndpointConfiguration.java b/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ServerManagerEndpointConfiguration.java
index 5d98b96..c2504ae 100644
--- a/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ServerManagerEndpointConfiguration.java
+++ b/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ServerManagerEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.as2.api.AS2ServerManager}.
*/
-@ApiParams(apiName = "server", description = "Receives EDI Messages over HTTP /",
+@ApiParams(apiName = "server", description = "Receives EDI Messages over HTTP",
apiMethods = {@ApiMethod(methodName = "listen")})
@UriParams
@Configurer
diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirCreateEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirCreateEndpointConfiguration.java
index f405c8e..8397e89 100644
--- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirCreateEndpointConfiguration.java
+++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirCreateEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.fhir.api.FhirCreate}.
*/
-@ApiParams(apiName = "create", description = "API for the create operation, which creates a new resource instance on the server /",
+@ApiParams(apiName = "create", description = "API for the create operation, which creates a new resource instance on the server",
apiMethods = {@ApiMethod(methodName = "resource", description="Creates a IBaseResource on the server"), @ApiMethod(methodName = "resource", description="Creates a IBaseResource on the server")})
@UriParams
@Configurer
diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirPatchEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirPatchEndpointConfiguration.java
index 85d4536..575fabb 100644
--- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirPatchEndpointConfiguration.java
+++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirPatchEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.fhir.api.FhirPatch}.
*/
-@ApiParams(apiName = "patch", description = "API for the patch operation, which performs a logical patch on a server resource /",
+@ApiParams(apiName = "patch", description = "API for the patch operation, which performs a logical patch on a server resource",
apiMethods = {@ApiMethod(methodName = "patchById", description="Applies the patch to the given resource ID"), @ApiMethod(methodName = "patchById", description="Applies the patch to the given resource ID"), @ApiMethod(methodName = "patchByUrl", description="Specifies that the update should be performed as a conditional create against a given search URL")})
@UriParams
@Configurer
diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java
index f213f7f..b2679b0 100644
--- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java
+++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.fhir.api.FhirRead}.
*/
-@ApiParams(apiName = "read", description = "API method for read operations /",
+@ApiParams(apiName = "read", description = "API method for read operations",
apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl")})
@UriParams
@Configurer
diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java
index 92fea0f..966fbaa 100644
--- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java
+++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.fhir.api.FhirUpdate}.
*/
-@ApiParams(apiName = "update", description = "API for the update operation, which performs a logical delete on a server resource /",
+@ApiParams(apiName = "update", description = "API for the update operation, which performs a logical delete on a server resource",
apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resourceBySearchUrl"), @ApiMethod(methodName = "resourceBySearchUrl")})
@UriParams
@Configurer
diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java
index 2611f42..ae1dc79 100644
--- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java
+++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java
@@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.apache.camel.component.fhir.api.FhirValidate}.
*/
-@ApiParams(apiName = "validate", description = "API for validating resources /",
+@ApiParams(apiName = "validate", description = "API for validating resources",
apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource")})
@UriParams
@Configurer
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 17636e9..637fdd6 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
@@ -14,8 +14,8 @@ import org.apache.camel.spi.UriParams;
/**
* Camel endpoint configuration for {@link org.zendesk.client.v2.Zendesk}.
*/
-@ApiParams(apiName = "DEFAULT", description = "/",
- apiMethods = {@ApiMethod(methodName = "addTagToOrganisations"), @ApiMethod(methodName = "addTagToTicket"), @ApiMethod(methodName = "addTagToTopics"), @ApiMethod(methodName = "associateAttachmentsToArticle"), @ApiMethod(methodName = "changeUserPassword"), @ApiMethod(methodName = "createArticle"), @ApiMethod(methodName = "createArticle"), @ApiMethod(methodName = "createArticleTranslation"), @ApiMethod(methodName = "createAutomation"), @ApiMethod(methodName = "createCategory"), @ [...]
+@ApiParams(apiName = "DEFAULT", description = "",
+ apiMethods = {@ApiMethod(methodName = "addTagToOrganisations"), @ApiMethod(methodName = "addTagToTicket"), @ApiMethod(methodName = "addTagToTopics"), @ApiMethod(methodName = "associateAttachmentsToArticle"), @ApiMethod(methodName = "changeUserPassword"), @ApiMethod(methodName = "createArticle"), @ApiMethod(methodName = "createArticle"), @ApiMethod(methodName = "createArticleTranslation"), @ApiMethod(methodName = "createAutomation"), @ApiMethod(methodName = "createCategory"), @ [...]
@UriParams
@Configurer
public final class ZendeskEndpointConfiguration extends ZendeskConfiguration {