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

snake_case guideline alignement #61

Closed
bigludo7 opened this issue Feb 22, 2023 · 4 comments
Closed

snake_case guideline alignement #61

bigludo7 opened this issue Feb 22, 2023 · 4 comments

Comments

@bigludo7
Copy link
Collaborator

          NOTE: As per guidelines, https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-design-guidelines.md

input/output params will be snake_case, so for a v1 we need to check in both proposals we are compliance with it.

https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-design-guidelines.md#42-inputoutput-resource-definition

_These considerations are below:

  • API input and output business data will follow the snake_case notation._

Originally posted by @PedroDiez in #56 (comment)

@bigludo7 bigludo7 changed the title snake_case guidelin : As per guidelines, https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-design-guidelines.md snake_case guideline alignement Feb 22, 2023
@PedroDiez
Copy link
Collaborator

Thanks for generating separate track @bigludo7.

Currently, the guidelines indicates the use of snake_case for input/output params.
Just to bear in mind looking forward a v1.0.0, we need to review it in proposals.

Have already check sim_swap an it is already done -> https://github.com/camaraproject/SimSwap/blob/main/code/API_definitions/CAMARA/checkSimSwap-v0.3.0.camara.swagger.yaml

And in QoD, they are in the process of adapting it.

@PedroDiez
Copy link
Collaborator

This topic is to be addressed in commonalities. Orange will open thread for second-think about it

@bigludo7
Copy link
Collaborator Author

I have open an issue there : camaraproject/WorkingGroups#157

@PedroDiez
Copy link
Collaborator

I am going to close this issue @bigludo7
As guidelines in CAMARA are updated and the changes are already being covered in PRs within this WG.
PR 60 - #60 (Merged)
PR 64 - #64 (Ongoing)

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

No branches or pull requests

2 participants