camaraproject / CarrierBillingCheckOut

Repository to describe, develop, document and test the Carrier Billing Check Out API family
Apache License 2.0
10 stars 9 forks source link

snake_case guideline alignement #61

Closed bigludo7 closed 1 year ago

bigludo7 commented 1 year ago
          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:

Originally posted by @PedroDiez in https://github.com/camaraproject/CarrierBillingCheckOut/issues/56#issuecomment-1431490244

PedroDiez commented 1 year ago

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 commented 1 year ago

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

bigludo7 commented 1 year ago

I have open an issue there : https://github.com/camaraproject/WorkingGroups/issues/157

PedroDiez commented 1 year ago

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 - https://github.com/camaraproject/CarrierBillingCheckOut/pull/60 (Merged) PR 64 - https://github.com/camaraproject/CarrierBillingCheckOut/pull/64 (Ongoing)