Naming of configuration values in DefaultClientHeadersFactoryImpl

[pehala]

The DefaultClientHeadersFactoryImpl is using configuration key org.eclipse.microprofile.rest.client.propagateHeaders configuration key name, while I would expect it to use mp.rest.client.propagateHeaders so I wanted to ask if microprofile has some guidelines for naming their own config keys and which one of these two options is the preferred one.

[andymc12]

Hi @pehala - good question. I don't know if the mp.* naming pattern is official, but it was proposed in MP issue 98 which was about six months after we had introduced the org.eclipse.microprofile.rest.client.propagateHeaders config property key.

It does sound like we should consider changing the property, but that should only be done in a major version release (because it would be a breaking change). Perhaps we could make that change when we switch dependencies to Jakarta EE9 (Jakarta REST 3.0 and CDI 3.0).

[Emily-Jiang]

The naming convention was not enforced and it is a recommendation for the new property names. I would not recommend to update the existing property names just becasue of the naming convention.

[WhiteCat22]

We discussed this issue on the MP Rest Client planning call today.

The plan is to support both properties but deprecate org.eclipse.microprofile.rest.client.propagateHeaders in the next release.

We will also have to specify that mp.rest.client.propagateHeaders takes priority if both are set.

[Emily-Jiang]

@WhiteCat22 will take a look at this.

[WhiteCat22]

Upon further investigation, we have decided to defer this issue until eclipse/microprofile#98 is resolved.

[jamezp]

+1 IMO we should wait for this until there is a decision at the global level.

[jim-krueger]

@Emily-Jiang, Can you please create a Milestone 4.1 and add this there, removing it from 4.0?