Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commonalities pass for corrections #19

Open
caubut-charter opened this issue Jul 26, 2024 · 4 comments
Open

Commonalities pass for corrections #19

caubut-charter opened this issue Jul 26, 2024 · 4 comments
Assignees

Comments

@caubut-charter
Copy link
Contributor

Problem description
Take another pass at commonalities looking for alignment corrections needed.

Expected behavior

Alternative solution

Additional context
Example to look at: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#appendix-a-infodescription-template-for-device-identification-from-access-token

@caubut-charter
Copy link
Contributor Author

@hdamker
Copy link
Contributor

hdamker commented Jul 27, 2024

Error codes also in this pass: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#61-standardized-use-of-camara-error-responses

For this you can copy/paste from https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.yaml

In addition you might want to consider which operation are "allowed" to return a 501 (NOT_IMPLEMENTED). There was a TSC discussion about camaraproject/Commonalities#246 with the result that "Mandatory endpoints must not have 501 defined as a valid response". Currently you have defined 501 as a potential response for all operations, but I don't think you want to indicate that the implementation of all these endpoints is "optional".

@hdamker
Copy link
Contributor

hdamker commented Jul 27, 2024

Another point for your pass: mandatory header x-correlator in every request and response, cf. https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#9-architecture-headers

@RandyLevensalor
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants