gnodet-bot commented on code in PR #30004:
URL: https://github.com/apache/camel/pull/30004#discussion_r4577805415
##########
components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/constants/FCHeaders.java:
##########
@@ -20,19 +20,31 @@
public final class FCHeaders {
- @Metadata(label = "producer", description = "FC service name override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The name of the service that contains the
function. This header replaces the serviceName option.",
Review Comment:
💡 **Consistency:** The corresponding endpoint option description in
`FCEndpoint.java` explains the full three-level fallback:
> The CamelAlibabaFcServiceName header replaces this option for a request
that the producer sends. If that header is not set, an exchange property of the
same name replaces this option.
This header description only says "This header replaces the serviceName
option", omitting the exchange property tier. The same applies to
`FUNCTION_NAME` and `QUALIFIER` below. Consider aligning with the endpoint
option phrasing, e.g.:
```suggestion
description = "The name of the service that contains the
function. This header replaces the serviceName option."
+ " If this header is not set, an exchange
property of the same name replaces the serviceName option.",
```
##########
components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/FCEndpoint.java:
##########
@@ -55,41 +55,69 @@
+ " and handler"))
public class FCEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
- enums = "invokeFunction,getFunction")
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaFcOperation header replaces this option"
+ + " for a request that the producer sends. If that
header is not set, an exchange property of the"
+ + " same name replaces this option.",
+ displayName = "Operation", label = "producer", enums =
"invokeFunction,getFunction")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Alibaba Cloud region", displayName = "Region")
+ @UriParam(description = "The region ID of Function Compute, for example
cn-hangzhou. Only used when the endpoint option is"
+ + " not set, to build the endpoint of Function
Compute. Not used when the fcClient option is set or"
+ + " autowired.",
+ displayName = "Region")
@Metadata(required = true)
private String region;
- @UriParam(description = "FC endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of Function Compute, which is a host
name without http:// or https://. The producer"
+ + " sends requests to it over HTTPS. If not set,
it is built from the region option, and one of the"
Review Comment:
💡 **Style (minor):** Passive voice — consider active voice:
```suggestion
+ " sends requests to it over HTTPS. If not set,
the producer builds it from the region option, and one of the"
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]