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

Validate API code and align with commonalities (meta-release item 1-2-3) #38

Closed
jgarciahospital opened this issue Jul 9, 2024 · 4 comments · Fixed by #47
Closed

Validate API code and align with commonalities (meta-release item 1-2-3) #38

jgarciahospital opened this issue Jul 9, 2024 · 4 comments · Fixed by #47
Labels

Comments

@jgarciahospital
Copy link
Collaborator

  • Confirm API definition
  • Design guidelines from Commonalities applied (TBC)
  • Guidelines from ICM applied (TBC)
@bigludo7
Copy link
Collaborator

Hello @jgarciahospital
For me we have an issue for the webhook as it is not aligned with commonalities 0.4.0

This is not a big change but as we're close to the deadline this is tricky.

See here the guidance

@rartych
Copy link

rartych commented Aug 28, 2024

I think here is asynchronous response, so I am not sure if guidelines related to event notification should be applied.

@bigludo7
Copy link
Collaborator

I think here is asynchronous response, so I am not sure if guidelines related to event notification should be applied.

I think as this is the same concept (use an url) we should use same attribute 'name'for developer's sake. But I got your point @rartych that this is not subscription. If you consider this is not an issue to commonalities v0.4 this is fine for me.
(I can raise an issue for name alignement for next release).

@jgarciahospital
Copy link
Collaborator Author

As proposed in the #44:

Making one additional review we find that QoD API suffered similar issue and finally they made the alignement (this Issue & PR summarizes). So, just for aligning with https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#instance-based-implicit-subscription, let me propose to roll back to initial plan and:

  • Update gherkin to be aligned with async auth
  • Update API yaml (I'll create a separate PR moving back to wip version)
  • Later we can sync this with the release PR

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