RealDevSquad / RealDevSquad/website-backend
Need to deprecate the user status API
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 276
- Avg merge
- 1d 26m
- Merged PRs (30d)
- 14
Description
There are two APIs whose naming convention is not appropriate and needs to be deprecated.
API - /users/status?state=<active/onboarding/idle/ooo>
/users/search?state=<active/onboarding/idle/ooo>
New API - users?q=status:<active/onboarding/idle/ooo>
users?q=search:<active/onboarding/idle/ooo>
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the existing /users/status and /users/search entry points and trace how their state values are handled. Compare them with users?q=status:<...> and users?q=search:<...>; done means the old naming is formally deprecated in favor of the new query forms, with the supported states preserved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100