RealDevSquad / RealDevSquad/website-backend
[RFC] creating new endpoints for `/intro`
@vinayak-trivedi is already working on this.
Since Oct 14, 2023.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 276
- Avg merge
- 1d 26m
- Merged PRs (30d)
- 14
Description
-
currently, the API used for getting the intro of a particular user is
users/:userId/intro, and for posting an intro we are using/users/self/intro -
In my opinion, this doesn't seem to be correct, as we are not doing anything with the user object and the intro is a separate resource in itself, which just have a key for userId
-
So we will replace the above two APIs with the following two APIs
-
GET: /intros/:userId: to get the intro of a particular user, this will be accessible by that user and superuser only -
POST: /intros/for adding the intro of the user
There is another API that will be created for super_user to get all the intros at once
GET: /intros/: this will return all the intros
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.
Assessment
This issue has not been assessed yet.