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

Mixed casing conventions for the REST API #95

Closed
jorgebay opened this issue Nov 11, 2022 · 2 comments · Fixed by #105
Closed

Mixed casing conventions for the REST API #95

jorgebay opened this issue Nov 11, 2022 · 2 comments · Fixed by #105
Assignees
Labels
api Change in the client API bug Something isn't working good first issue Good for newcomers
Milestone

Comments

@jorgebay
Copy link
Contributor

We recently introduced consumer_id querystring parameter which uses snake case but the API uses camelCase...

We should change it to consumerId on v0.5.0, while still supporting the snake case version until v0.7.0.

@jorgebay jorgebay added bug Something isn't working api Change in the client API labels Nov 11, 2022
@jorgebay jorgebay added this to the 0.5.0 milestone Nov 11, 2022
@jorgebay jorgebay added the good first issue Good for newcomers label Nov 13, 2022
@akisan13245
Copy link

i think camelcase is not as good as snakecase ,because snakecase can be more readable and multi-user but if api only supports camel it's ok,you can still use camelcase on 0.7.0 for your api

@jorgebay
Copy link
Contributor Author

@akisan13245 I agree, I think snake case is more readable and newer projects tend to go in the direction of snake case for json messages. The problem is that all the messages use camelCase and it would be a huge (breaking) change to change it.

Hopefully, unifying the naming convention towards one (camelCase) is better than having mixed ones :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Change in the client API bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants