CAMEL-17792: Add documentation about the message headers (E-F)#7242
Merged
Conversation
davsclaus
approved these changes
Mar 21, 2022
vpaturet
pushed a commit
to vpaturet/camel
that referenced
this pull request
Mar 29, 2022
…e#7242) ## Motivation It is now possible to document a message header using annotations, let's leverage it to document the headers of the components. ## Modifications For all the components whose name starts with a E or F * Document the messages headers using the annotations * Migrate the existing documentation of message headers to use the annotations instead * Re-define shared constants like those in `Exchange` in the local constants class to be able to document it within the context of current component. * Add new constants class when it does not exist yet * CAMEL-17792: Add doc about the message headers of camel-ehcache * CAMEL-17792: Add doc about the message headers of camel-elasticsearch-rest * CAMEL-17792: Add doc about the message headers of camel-elsql * CAMEL-17792: Add doc about the message headers of camel-etcd * CAMEL-17792: Add doc about the message headers of camel-exec * CAMEL-17792: Add doc about the message headers of camel-facebook * CAMEL-17792: Add doc about the message headers of camel-file * CAMEL-17792: Add doc about the message headers of camel-file-watch * CAMEL-17792: Add doc about the message headers of camel-flatpack * CAMEL-17792: Add doc about the message headers of camel-flink * CAMEL-17792: Add doc about the message headers of camel-fop * CAMEL-17792: Add doc about the message headers of camel-freemarker * CAMEL-17792: Add doc about the message headers of camel-ftp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://issues.apache.org/jira/browse/CAMEL-17792
Motivation
It is now possible to document a message header using annotations, let's leverage it to document the headers of the components.
Modifications
For all the components whose name starts with a E or F
Exchangein the local constants class to be able to document it within the context of current component.