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 50bb96c CAMEL-15554: api component - allow to specify description in pom.xml for apis 50bb96c is described below commit 50bb96c45c8ecc9f81e321d66af7e9d2b60bc699 Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Sun Sep 20 09:22:07 2020 +0200 CAMEL-15554: api component - allow to specify description in pom.xml for apis --- .../org/apache/camel/catalog/docs/braintree-component.adoc | 14 +++++++------- components/camel-braintree/pom.xml | 7 +++++++ ...CreditCardVerificationGatewayEndpointConfiguration.java | 2 +- .../DocumentUploadGatewayEndpointConfiguration.java | 2 +- .../MerchantAccountGatewayEndpointConfiguration.java | 2 +- .../PaymentMethodGatewayEndpointConfiguration.java | 2 +- .../PaymentMethodNonceGatewayEndpointConfiguration.java | 2 +- ...SettlementBatchSummaryGatewayEndpointConfiguration.java | 2 +- .../WebhookNotificationGatewayEndpointConfiguration.java | 2 +- .../org/apache/camel/component/braintree/braintree.json | 14 +++++++------- .../camel-braintree/src/main/docs/braintree-component.adoc | 14 +++++++------- .../components/modules/ROOT/pages/braintree-component.adoc | 14 +++++++------- .../apache/camel/maven/AbstractApiMethodGeneratorMojo.java | 4 +++- 13 files changed, 45 insertions(+), 36 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/braintree-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/braintree-component.adoc index f62301d..1f4ba73 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/braintree-component.adoc +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/braintree-component.adoc @@ -143,18 +143,18 @@ There are 14 API groups as listed in the table below: | API Name | Description | *address* | Provides methods to create, delete, find, and update Address objects | *clientToken* | Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly -| *creditCardVerification* | +| *creditCardVerification* | To verify credit card information | *customer* | Provides methods to create, delete, find, and update Customer objects | *dispute* | Provides methods to interact with Dispute objects -| *documentUpload* | -| *merchantAccount* | -| *paymentMethod* | -| *paymentMethodNonce* | +| *documentUpload* | API to upload evidence documents +| *merchantAccount* | Provides methods to create, find, and update MerchantAccount objects +| *paymentMethod* | Provides methods to interact with payments +| *paymentMethodNonce* | Provides methods to interact with nonce payments | *report* | Provides methods to interact with reports -| *settlementBatchSummary* | +| *settlementBatchSummary* | Provides methods to interact wit settlement summaries | *subscription* | Provides methods to interact with Subscriptions | *transaction* | Provides methods to interact with Transactions -| *webhookNotification* | +| *webhookNotification* | To retrieve notifications via webhooks |=== Each API is documented in the following sections to come. diff --git a/components/camel-braintree/pom.xml b/components/camel-braintree/pom.xml index b59196d..f7ed10c 100644 --- a/components/camel-braintree/pom.xml +++ b/components/camel-braintree/pom.xml @@ -116,6 +116,7 @@ </api> <api> <apiName>creditCardVerification</apiName> + <apiDescription>To verify credit card information</apiDescription> <proxyClass>com.braintreegateway.CreditCardVerificationGateway</proxyClass> <fromJavasource /> </api> @@ -138,11 +139,13 @@ </api> <api> <apiName>documentUpload</apiName> + <apiDescription>API to upload evidence documents</apiDescription> <proxyClass>com.braintreegateway.DocumentUploadGateway</proxyClass> <fromJavasource /> </api> <api> <apiName>merchantAccount</apiName> + <apiDescription>Provides methods to create, find, and update MerchantAccount objects</apiDescription> <proxyClass>com.braintreegateway.MerchantAccountGateway</proxyClass> <fromJavasource /> <substitutions> @@ -165,6 +168,7 @@ </api> <api> <apiName>paymentMethod</apiName> + <apiDescription>Provides methods to interact with payments</apiDescription> <proxyClass>com.braintreegateway.PaymentMethodGateway</proxyClass> <fromJavasource> <excludeMethods>.*parse.*</excludeMethods> @@ -188,6 +192,7 @@ </api> <api> <apiName>paymentMethodNonce</apiName> + <apiDescription>Provides methods to interact with nonce payments</apiDescription> <proxyClass>com.braintreegateway.PaymentMethodNonceGateway</proxyClass> <fromJavasource> <excludeMethods>.*parse.*</excludeMethods> @@ -205,6 +210,7 @@ </api> <api> <apiName>settlementBatchSummary</apiName> + <apiDescription>Provides methods to interact wit settlement summaries</apiDescription> <proxyClass>com.braintreegateway.SettlementBatchSummaryGateway</proxyClass> <fromJavasource /> </api> @@ -245,6 +251,7 @@ </api> <api> <apiName>webhookNotification</apiName> + <apiDescription>To retrieve notifications via webhooks</apiDescription> <proxyClass>com.braintreegateway.WebhookNotificationGateway</proxyClass> <fromJavasource /> </api> diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/CreditCardVerificationGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/CreditCardVerificationGatewayEndpointConfiguration.java index bf78404..a2c6e85 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/CreditCardVerificationGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/CreditCardVerificationGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.CreditCardVerificationGateway}. */ -@ApiParams(apiName = "creditCardVerification", description = "", +@ApiParams(apiName = "creditCardVerification", description = "To verify credit card information", apiMethods = {@ApiMethod(methodName = "create", signatures={"com.braintreegateway.Result<com.braintreegateway.CreditCardVerification> create(com.braintreegateway.CreditCardVerificationRequest request)"}), @ApiMethod(methodName = "find", signatures={"com.braintreegateway.CreditCardVerification find(String id)"}), @ApiMethod(methodName = "search", signatures={"com.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVerification> search(com.braintreegateway.CreditC [...] @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/DocumentUploadGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/DocumentUploadGatewayEndpointConfiguration.java index 16a9503..997b170 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/DocumentUploadGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/DocumentUploadGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.DocumentUploadGateway}. */ -@ApiParams(apiName = "documentUpload", description = "", +@ApiParams(apiName = "documentUpload", description = "API to upload evidence documents", apiMethods = {@ApiMethod(methodName = "create", signatures={"com.braintreegateway.Result<com.braintreegateway.DocumentUpload> create(com.braintreegateway.DocumentUploadRequest request)"})}, aliases = {}) @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/MerchantAccountGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/MerchantAccountGatewayEndpointConfiguration.java index ca64ebb..73a2790 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/MerchantAccountGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/MerchantAccountGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.MerchantAccountGateway}. */ -@ApiParams(apiName = "merchantAccount", description = "", +@ApiParams(apiName = "merchantAccount", description = "Provides methods to create, find, and update MerchantAccount objects", apiMethods = {@ApiMethod(methodName = "all", signatures={"com.braintreegateway.PaginatedCollection<com.braintreegateway.MerchantAccount> all()"}), @ApiMethod(methodName = "create", signatures={"com.braintreegateway.Result<com.braintreegateway.MerchantAccount> create(com.braintreegateway.MerchantAccountRequest request)"}), @ApiMethod(methodName = "createForCurrency", signatures={"com.braintreegateway.Result<com.braintreegateway.MerchantAccount> createForCurrency(com.braintreega [...] @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodGatewayEndpointConfiguration.java index f7c14e5..84ea596 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.PaymentMethodGateway}. */ -@ApiParams(apiName = "paymentMethod", description = "", +@ApiParams(apiName = "paymentMethod", description = "Provides methods to interact with payments", apiMethods = {@ApiMethod(methodName = "create", signatures={"com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> create(com.braintreegateway.PaymentMethodRequest request)"}), @ApiMethod(methodName = "delete", signatures={"com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token)", "com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token, com.braintreegateway.PaymentMethodDeleteRequ [...] @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodNonceGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodNonceGatewayEndpointConfiguration.java index 45f2429..55edfaf 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodNonceGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/PaymentMethodNonceGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.PaymentMethodNonceGateway}. */ -@ApiParams(apiName = "paymentMethodNonce", description = "", +@ApiParams(apiName = "paymentMethodNonce", description = "Provides methods to interact with nonce payments", apiMethods = {@ApiMethod(methodName = "create", signatures={"com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(String paymentMethodToken)", "com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(com.braintreegateway.PaymentMethodNonceRequest request)"}), @ApiMethod(methodName = "find", signatures={"com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce)"})}, aliases = {}) @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/SettlementBatchSummaryGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/SettlementBatchSummaryGatewayEndpointConfiguration.java index a1c050e..c2ab2ed 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/SettlementBatchSummaryGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/SettlementBatchSummaryGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.SettlementBatchSummaryGateway}. */ -@ApiParams(apiName = "settlementBatchSummary", description = "", +@ApiParams(apiName = "settlementBatchSummary", description = "Provides methods to interact wit settlement summaries", apiMethods = {@ApiMethod(methodName = "generate", signatures={"com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate)", "com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate, String groupByCustomField)"}), }, aliases = {}) @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/WebhookNotificationGatewayEndpointConfiguration.java b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/WebhookNotificationGatewayEndpointConfiguration.java index ca56b75..8d3172e 100644 --- a/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/WebhookNotificationGatewayEndpointConfiguration.java +++ b/components/camel-braintree/src/generated/java/org/apache/camel/component/braintree/WebhookNotificationGatewayEndpointConfiguration.java @@ -14,7 +14,7 @@ import org.apache.camel.spi.UriParams; /** * Camel endpoint configuration for {@link com.braintreegateway.WebhookNotificationGateway}. */ -@ApiParams(apiName = "webhookNotification", description = "", +@ApiParams(apiName = "webhookNotification", description = "To retrieve notifications via webhooks", apiMethods = {@ApiMethod(methodName = "parse", signatures={"com.braintreegateway.WebhookNotification parse(String signature, String payload)"}), @ApiMethod(methodName = "verify", signatures={"String verify(String challenge)"})}, aliases = {}) @UriParams @Configurer diff --git a/components/camel-braintree/src/generated/resources/org/apache/camel/component/braintree/braintree.json b/components/camel-braintree/src/generated/resources/org/apache/camel/component/braintree/braintree.json index 3849abd..853edad 100644 --- a/components/camel-braintree/src/generated/resources/org/apache/camel/component/braintree/braintree.json +++ b/components/camel-braintree/src/generated/resources/org/apache/camel/component/braintree/braintree.json @@ -69,18 +69,18 @@ "apis": { "address": { "description": "Provides methods to create, delete, find, and update Address objects", "methods": { "create": { "description": "Creates an Address for a Customer", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Address> create(String customerId, com.braintreegateway.AddressRequest request)" ] }, "delete": { "description": "Deletes a Customer's Address", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Address> delete(String customerId, [...] "clientToken": { "description": "Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly", "methods": { "generate": { "description": "", "signatures": [ "String generate()", "String generate(com.braintreegateway.ClientTokenRequest request)" ] } } }, - "creditCardVerification": { "description": "", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.CreditCardVerification> create(com.braintreegateway.CreditCardVerificationRequest request)" ] }, "find": { "description": "", "signatures": [ "com.braintreegateway.CreditCardVerification find(String id)" ] }, "search": { "description": "", "signatures": [ "com.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVer [...] + "creditCardVerification": { "description": "To verify credit card information", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.CreditCardVerification> create(com.braintreegateway.CreditCardVerificationRequest request)" ] }, "find": { "description": "", "signatures": [ "com.braintreegateway.CreditCardVerification find(String id)" ] }, "search": { "description": "", "signatures": [ "com.braintreegateway.ResourceCollection<c [...] "customer": { "description": "Provides methods to create, delete, find, and update Customer objects", "methods": { "create": { "description": "Creates a Customer", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Customer> create(com.braintreegateway.CustomerRequest request)" ] }, "delete": { "description": "Deletes a Customer by id", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Customer> delete(String id)" ] }, "find": { "description": "Finds a [...] "dispute": { "description": "Provides methods to interact with Dispute objects", "methods": { "accept": { "description": "Accept a Dispute, given a dispute ID", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Dispute> accept(String id)" ] }, "addFileEvidence": { "description": "Add File Evidence to a Dispute, given an ID and a FileEvidenceRequest File evidence request", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidenc [...] - "documentUpload": { "description": "", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.DocumentUpload> create(com.braintreegateway.DocumentUploadRequest request)" ] } } }, - "merchantAccount": { "description": "", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.MerchantAccount> create(com.braintreegateway.MerchantAccountRequest request)" ] }, "createForCurrency": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.MerchantAccount> createForCurrency(com.braintreegateway.MerchantAccountCreateForCurrencyRequest request)" ] }, "fetchMerchantAccounts": { "descript [...] - "paymentMethod": { "description": "", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> create(com.braintreegateway.PaymentMethodRequest request)" ] }, "delete": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token)", "com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token, com.braint [...] - "paymentMethodNonce": { "description": "", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(String paymentMethodToken)", "com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(com.braintreegateway.PaymentMethodNonceRequest request)" ] }, "find": { "description": "", "signatures": [ "com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce)" ] } } }, + "documentUpload": { "description": "API to upload evidence documents", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.DocumentUpload> create(com.braintreegateway.DocumentUploadRequest request)" ] } } }, + "merchantAccount": { "description": "Provides methods to create, find, and update MerchantAccount objects", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.MerchantAccount> create(com.braintreegateway.MerchantAccountRequest request)" ] }, "createForCurrency": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.MerchantAccount> createForCurrency(com.braintreegateway.MerchantAccountCreateFo [...] + "paymentMethod": { "description": "Provides methods to interact with payments", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> create(com.braintreegateway.PaymentMethodRequest request)" ] }, "delete": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token)", "com.braintreegateway.Result<com.braintreegateway.? extends Paym [...] + "paymentMethodNonce": { "description": "Provides methods to interact with nonce payments", "methods": { "create": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(String paymentMethodToken)", "com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(com.braintreegateway.PaymentMethodNonceRequest request)" ] }, "find": { "description": "", "signatures": [ "com.braintreegateway.PaymentMethodNonce find(S [...] "report": { "description": "Provides methods to interact with reports", "methods": { "transactionLevelFees": { "description": "Retrieves a Transaction-Level Fee Report", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.TransactionLevelFeeReport> transactionLevelFees(com.braintreegateway.TransactionLevelFeeReportRequest request)" ] } } }, - "settlementBatchSummary": { "description": "", "methods": { "generate": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate)", "com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate, String groupByCustomField)" ] } } }, + "settlementBatchSummary": { "description": "Provides methods to interact wit settlement summaries", "methods": { "generate": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate)", "com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate, String groupByCustomField)" ] } } }, "subscription": { "description": "Provides methods to interact with Subscriptions", "methods": { "cancel": { "description": "Cancels the Subscription with the given id", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Subscription> cancel(String id)" ] }, "create": { "description": "Creates a Subscription", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Subscription> create(com.braintreegateway.SubscriptionRequest request)" ] }, "delete": { "descr [...] "transaction": { "description": "Provides methods to interact with Transactions", "methods": { "cancelRelease": { "description": "Cancels a pending release of a transaction with the given id from escrow", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Transaction> cancelRelease(String id)" ] }, "cloneTransaction": { "description": "", "signatures": [ "com.braintreegateway.Result<com.braintreegateway.Transaction> cloneTransaction(String id, com.braintreegateway.Tran [...] - "webhookNotification": { "description": "", "methods": { "parse": { "description": "", "signatures": [ "com.braintreegateway.WebhookNotification parse(String signature, String payload)" ] }, "verify": { "description": "", "signatures": [ "String verify(String challenge)" ] } } } + "webhookNotification": { "description": "To retrieve notifications via webhooks", "methods": { "parse": { "description": "", "signatures": [ "com.braintreegateway.WebhookNotification parse(String signature, String payload)" ] }, "verify": { "description": "", "signatures": [ "String verify(String challenge)" ] } } } }, "apiProperties": { "address": { "methods": { "create": { "properties": { "customerId": { "kind": "parameter", "displayName": "Customer Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id of the Customer", "optional": false }, "request": { "kind": "parameter", "displayName": "Request", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.braintreegateway.Add [...] diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc index f62301d..1f4ba73 100644 --- a/components/camel-braintree/src/main/docs/braintree-component.adoc +++ b/components/camel-braintree/src/main/docs/braintree-component.adoc @@ -143,18 +143,18 @@ There are 14 API groups as listed in the table below: | API Name | Description | *address* | Provides methods to create, delete, find, and update Address objects | *clientToken* | Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly -| *creditCardVerification* | +| *creditCardVerification* | To verify credit card information | *customer* | Provides methods to create, delete, find, and update Customer objects | *dispute* | Provides methods to interact with Dispute objects -| *documentUpload* | -| *merchantAccount* | -| *paymentMethod* | -| *paymentMethodNonce* | +| *documentUpload* | API to upload evidence documents +| *merchantAccount* | Provides methods to create, find, and update MerchantAccount objects +| *paymentMethod* | Provides methods to interact with payments +| *paymentMethodNonce* | Provides methods to interact with nonce payments | *report* | Provides methods to interact with reports -| *settlementBatchSummary* | +| *settlementBatchSummary* | Provides methods to interact wit settlement summaries | *subscription* | Provides methods to interact with Subscriptions | *transaction* | Provides methods to interact with Transactions -| *webhookNotification* | +| *webhookNotification* | To retrieve notifications via webhooks |=== Each API is documented in the following sections to come. diff --git a/docs/components/modules/ROOT/pages/braintree-component.adoc b/docs/components/modules/ROOT/pages/braintree-component.adoc index 522c84b..c65e9fd 100644 --- a/docs/components/modules/ROOT/pages/braintree-component.adoc +++ b/docs/components/modules/ROOT/pages/braintree-component.adoc @@ -145,18 +145,18 @@ There are 14 API groups as listed in the table below: | API Name | Description | *address* | Provides methods to create, delete, find, and update Address objects | *clientToken* | Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly -| *creditCardVerification* | +| *creditCardVerification* | To verify credit card information | *customer* | Provides methods to create, delete, find, and update Customer objects | *dispute* | Provides methods to interact with Dispute objects -| *documentUpload* | -| *merchantAccount* | -| *paymentMethod* | -| *paymentMethodNonce* | +| *documentUpload* | API to upload evidence documents +| *merchantAccount* | Provides methods to create, find, and update MerchantAccount objects +| *paymentMethod* | Provides methods to interact with payments +| *paymentMethodNonce* | Provides methods to interact with nonce payments | *report* | Provides methods to interact with reports -| *settlementBatchSummary* | +| *settlementBatchSummary* | Provides methods to interact wit settlement summaries | *subscription* | Provides methods to interact with Subscriptions | *transaction* | Provides methods to interact with Transactions -| *webhookNotification* | +| *webhookNotification* | To retrieve notifications via webhooks |=== Each API is documented in the following sections to come. diff --git a/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/AbstractApiMethodGeneratorMojo.java b/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/AbstractApiMethodGeneratorMojo.java index d627a38..e5bbf24 100644 --- a/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/AbstractApiMethodGeneratorMojo.java +++ b/tooling/maven/camel-api-component-maven-plugin/src/main/java/org/apache/camel/maven/AbstractApiMethodGeneratorMojo.java @@ -100,7 +100,9 @@ public abstract class AbstractApiMethodGeneratorMojo extends AbstractApiMethodBa List<SignatureModel> data = getSignatureList(); for (SignatureModel model : data) { // we get the api description via the method signature (not ideal but that's the way of the old parser API) - this.apiDescription = model.getApiDescription(); + if (model.getApiDescription() != null) { + this.apiDescription = model.getApiDescription(); + } signatures.add(model.getSignature()); String method = StringHelper.before(model.getSignature(), "("); if (method != null && method.contains(" ")) {