camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
37 stars 60 forks source link

Add X-Correlator and other fixes #283

Closed jlurien closed 2 months ago

jlurien commented 2 months ago

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #271 Fixes #282

Changelog input

- Added x-correlator header to requests and responses
linux-foundation-easycla[bot] commented 2 months ago

CLA Not Signed

eric-murray commented 2 months ago

Parameter name in the Design Guidelines is X-Correlator. I think the YAML should be consistent with the guidelines.

jlurien commented 2 months ago

Parameter name in the Design Guidelines is X-Correlator. I think the YAML should be consistent with the guidelines.

Yes, situation is that almost all CAMARA APIs are specifying x-correlator in lower case, so we either fix the guidelines or fix all the specs. I will raise this in Commonalities:

https://github.com/camaraproject/Commonalities/issues/191

hdamker commented 2 months ago

Yes, situation is that almost all CAMARA APIs are specifying x-correlator in lower case, so we either fix the guidelines or fix all the specs.

We shouldn't wait with the merge of the PR until this is decided in Commonalities, as that will block the work on the planned API split. Therefore my proposal: we go here with lower case x-correlator (it's only "wip") but adding a new issue that we have to observe the outcome of https://github.com/camaraproject/Commonalities/issues/191 and, if the decision there will be for upper case have to adapt.

@eric-murray @RandyLevensalor: if that makes sense for you, please approve the PR.

The second point, about "Missing CLA Authorisation": CAMARA Board has decided to postpone the EasyCLA introduction at least until the next board meeting. Therefore I asked @wrathwolf to deactivate the check also for our repository for the time being.