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.

Sign up for GitHub

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

Jump to bottom

Update api/v1/person endpoint to not use camel-case personType query parameter #9389

Closed
jkuester opened this issue Aug 28, 2024 · 0 comments · Fixed by #9390
Closed

Update api/v1/person endpoint to not use camel-case personType query parameter #9389

jkuester opened this issue Aug 28, 2024 · 0 comments · Fixed by #9390
Assignees
@jkuester
Labels
Type: Improvement Make something better
Milestone
4.11.0

Comments

@jkuester
Copy link
Contributor

We do not have a ton of consistent conventions for our REST api, but one that we do have is that all our current query parameter names are snake-case and not camel-case.

For the recently added (and as of yet unreleased) support for getting persons by type, I missed in the code review that the query parameter was named personType.

We should just change this to be type since semantically the "person" part is redundant: api/v1/person?type=my-person-type.
@jkuester jkuester added the Type: Improvement Make something better label Aug 28, 2024
@jkuester jkuester added this to the 4.11.0 milestone Aug 28, 2024
@jkuester jkuester mentioned this issue Aug 28, 2024
Merged
3 tasks
jkuester added a commit that referenced this issue Aug 28, 2024
@jkuester
fix(#9389): update api/v1/person query param from personType to type
bd40a5d
This was referenced Aug 28, 2024
Merged
Merged
sugat009 pushed a commit that referenced this issue Aug 29, 2024
@jkuester
fix(#9389): update api/v1/person query param from personType to type (#…
d66140c 
…9390)
sugat009 pushed a commit that referenced this issue Aug 29, 2024
@jkuester @sugat009
fix(#9389): update api/v1/person query param from personType to type (#…
beea361 
…9390)
@andrablaj andrablaj moved this from Todo to Done in Product Team Activities Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jkuester jkuester

Labels
Type: Improvement Make something better
Projects
Product Team Activities
Status: Done
Milestone
4.11.0
Development

Successfully merging a pull request may close this issue.

fix(#9389): update api/v1/person query param from personType to type medic/cht-core
1 participant
@jkuester