[CAMEL-17858] camel-core - Log EIP metadata for common use-cases

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Resolved
• Fix Version/s: 4.x
• Component/s: camel-core, eip
• Estimated Complexity: Unknown
• Assignee: Unassigned
• Reporter: Claus Ibsen
• Created: 26/Mar/22 10:11
• Updated: 20/Aug/24 10:26
• Resolved: 20/Aug/24 10:26

Description

For low-code users that get started with Camel would not as easily not how to use the Log EIP to output common use-cases such as

• ${body}
• ${header.xxx}
• ${exception.message}

etc

So we should find a way to have such patterns in the metadata that we can present in the documentation and for tooling.

It could be examples like we have for kamelets.

@Metadata(examples = "${body}", "${header.myHeaderName}", ...)

We should possible have both the value and a description for each example so we can have help test that go with that.

The openapi spec also have examples so we can be inspired there too.