This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit f81c93197b097d9f3f17726db17a3227f605c31f Author: Nicolas Filotto <[email protected]> AuthorDate: Tue Mar 22 12:48:36 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-google-calendar --- .../component/google/calendar/stream/google-calendar-stream.json | 3 +++ .../src/main/docs/google-calendar-stream-component.adoc | 4 +++- .../google/calendar/stream/GoogleCalendarStreamConstants.java | 3 +++ .../google/calendar/stream/GoogleCalendarStreamEndpoint.java | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/components/camel-google/camel-google-calendar/src/generated/resources/org/apache/camel/component/google/calendar/stream/google-calendar-stream.json b/components/camel-google/camel-google-calendar/src/generated/resources/org/apache/camel/component/google/calendar/stream/google-calendar-stream.json index 75a6684..1923176 100644 --- a/components/camel-google/camel-google-calendar/src/generated/resources/org/apache/camel/component/google/calendar/stream/google-calendar-stream.json +++ b/components/camel-google/camel-google-calendar/src/generated/resources/org/apache/camel/component/google/calendar/stream/google-calendar-stream.json @@ -44,6 +44,9 @@ "refreshToken": { "kind": "property", "displayName": "Refresh Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration", "configurationField": "configuration", "description": "OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new acce [...] "user": { "kind": "property", "displayName": "User", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration", "configurationField": "configuration", "description": "The email address of the user the application is trying to impersonate in the service account flow." } }, + "headers": { + "CamelGoogleCalendarEventId": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The calendar event id" } + }, "properties": { "index": { "kind": "path", "displayName": "Index", "group": "consumer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration", "configurationField": "configuration", "description": "Specifies an index for the endpoint" }, "applicationName": { "kind": "parameter", "displayName": "Application Name", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration", "configurationField": "configuration", "description": "Google Calendar application name. Example would be camel-google-calendar\/1.0" }, diff --git a/components/camel-google/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc b/components/camel-google/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc index 1cfa550..ca267e8 100644 --- a/components/camel-google/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc +++ b/components/camel-google/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc @@ -69,7 +69,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: START // endpoint options: END - +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END include::spring-boot:partial$starter.adoc[] diff --git a/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamConstants.java b/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamConstants.java index 4d2a279..cb5e5c7 100644 --- a/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamConstants.java +++ b/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamConstants.java @@ -16,11 +16,14 @@ */ package org.apache.camel.component.google.calendar.stream; +import org.apache.camel.spi.Metadata; + /** * Constants used in Camel Google Calendar Stream */ public final class GoogleCalendarStreamConstants { + @Metadata(description = "The calendar event id", javaType = "String") public static final String EVENT_ID = "CamelGoogleCalendarEventId"; /** diff --git a/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamEndpoint.java b/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamEndpoint.java index 69c3179..87d23f0 100644 --- a/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamEndpoint.java +++ b/components/camel-google/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/stream/GoogleCalendarStreamEndpoint.java @@ -38,7 +38,7 @@ import org.apache.camel.util.ObjectHelper; title = "Google Calendar Stream", syntax = "google-calendar-stream:index", consumerOnly = true, - category = { Category.CLOUD }) + category = { Category.CLOUD }, headersClass = GoogleCalendarStreamConstants.class) public class GoogleCalendarStreamEndpoint extends ScheduledPollEndpoint { @UriParam
