arunsrajan commented on code in PR #26010: URL: https://github.com/apache/camel/pull/26010#discussion_r3913345083
########## components/camel-alibaba/camel-alibaba-eventbridge/src/main/docs/alibaba-eventbridge-component.adoc: ########## @@ -44,56 +44,243 @@ include::partial$component-endpoint-headers.adoc[] == Usage -=== Message headers evaluated by the EventBridge producer +=== Message Headers and Properties -[width="100%",cols="10%,10%,80%",options="header",] +The component defines constants in package `org.apache.camel.component.alibaba.eventbridge.constants`: + +* `AlibabaEventBridgeHeaders` defines all message header constants evaluated or set by the EventBridge producer. +* `AlibabaEventBridgeProperties` extends `AlibabaEventBridgeHeaders` and provides constants for Exchange properties (such as `OPERATION`), while inheriting all header constants. + +==== Message headers evaluated by the EventBridge producer + +[width="100%",cols="25%,25%,10%,40%",options="header",] |======================================================================= -|Header |Type |Description +|Constant (`AlibabaEventBridgeHeaders`) |Header String |Type |Description + +|`EVENT_BUS_NAME` |`CamelAlibabaEventBridgeEventBusName` |`String` | Event bus name to publish events to (overrides the endpoint option). + +|`EVENT_SOURCE` |`CamelAlibabaEventBridgeEventSource` |`String` | Event source URI (overrides the endpoint option). -|`CamelAlibabaEventBridgeOperation` |`String` | Name of operation to invoke +|`EVENT_TYPE` |`CamelAlibabaEventBridgeEventType` |`String` | Event type (overrides the endpoint option). -|`CamelAlibabaEventBridgeEventBusName` |`String` | Event bus name to publish events to (overrides the endpoint option) +|`EVENT_SUBJECT` |`CamelAlibabaEventBridgeEventSubject` |`String` | Event subject (overrides the endpoint option). -|`CamelAlibabaEventBridgeEventSource` |`String` | Event source URI (overrides the endpoint option) +|`VALIDATE_EVENT_SOURCE` |`CamelAlibabaEventBridgeValidateEventSource` |`boolean` | Whether to validate the event bus and event source against Alibaba Cloud. -|`CamelAlibabaEventBridgeEventType` |`String` | Event type (overrides the endpoint option) +|`VALIDATE_EVENT_TYPE` |`CamelAlibabaEventBridgeValidateEventType` |`boolean` | Whether to validate the event type against Alibaba Cloud rule filter patterns for that source. -|`CamelAlibabaEventBridgeEventSubject` |`String` | Event subject (overrides the endpoint option) +|`VALIDATE_EVENT_SPEC` |`CamelAlibabaEventBridgeValidateEventSpec` |`boolean` | Whether to enforce CloudEvents 1.0 specification compliance checks (defaults to `true`). + +|`ALLOWED_EVENT_SOURCES` |`CamelAlibabaEventBridgeAllowedEventSources` |`Object` | Allowed event sources and source-scoped event types per bus (DSL string, JSON string, Map, or List). + +|`EVENT_SOURCE_CACHE_TTL` |`CamelAlibabaEventBridgeEventSourceCacheTtl` |`long` | Cache time-to-live in milliseconds for verified Alibaba Cloud event bus and type metadata (defaults to `300000` / 5 minutes). |======================================================================= -If any of the above headers are set, they will override their corresponding query parameter value. +If any of the above headers are set, they will override their corresponding exchange property or query parameter value. -=== Message headers set by the EventBridge producer +==== Message headers set by the EventBridge producer -[width="100%",cols="10%,10%,80%",options="header",] +[width="100%",cols="25%,25%,10%,40%",options="header",] +|======================================================================= +|Constant (`AlibabaEventBridgeHeaders`) |Header String |Type |Description + +|`REQUEST_ID` |`CamelAlibabaEventBridgeRequestId` |`String` | Alibaba Cloud request ID returned by EventBridge. + +|======================================================================= Review Comment: Fixed. Restructured the *Event Validation and Caching* section in `alibaba-eventbridge-component.adoc` using clean AsciiDoc bulleted lists and subheadings, eliminating nested numbered list indexing issues. The catalog documentation mirror under `catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-eventbridge-component.adoc` has also been synced. -- 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]
