Issue-981: Restore optional usage of chatId Configuration Option and correct narrative

[manstis]

Following discussions with @valdar it was felt that including a default value and improving the documentation was the best approach. Keeping the parameter as required forces Users to explicitly consider how/where to set the value. Reverting optional behaviour can lead to implicit failures that can be more difficult to diagnose.

@valdar @oscerd WDYT?

[oscerd]

LGTM

[oscerd]

I don't think default should be set

[oscerd]

If you set a default value, it will be set on the endpoint by default.

[manstis]

This is @valdar's preference.

However I see your point too. Damn. Why do I always see both sides to things!?!?

The User is forced to either provide a real value for the endpoint configuration or set its value in the header where it then takes precedence over the endpoint configuration. The default value is explicitly mentioned in the updated documentation and advises it could lead to delivery failure.

It's a difficult situation: The parameter is required, it is not optional; but where it can be set (endpoint or per message) means Camel fails to deploy the Kamelet if the User does not set a value in the Configuration Options when marked as required.

We want to somehow impose configuration of a chatId on Users.

I'll chat to @valdar again..

[manstis]

OK. I've restored the required nature of the chatId parameter and hopefully made the documentation bullet proof!

[manstis]

Assuming this is acceptable; please confirm you'll want the other affected branches (3.x and 3.20.x) corrected too.

[oscerd]

This should also be backported on 3.x and 3.20.x

[manstis]

This should also be backported on 3.x and 3.20.x

See:

• [3.x] Issue-981: Restore required setting for chatId and made documentation clearer #1319
• [3.20.x] Issue-981: Restore required setting for chatId and made documentation clearer. #1320