generated from Real-Dev-Squad/website-template
-
Notifications
You must be signed in to change notification settings - Fork 49
API contract for GET tasks/paginated #82
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
Open
ivinayakg
wants to merge
5
commits into
Real-Dev-Squad:main
Choose a base branch
from
ivinayakg:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+24
−18
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ea3d554
API contract for GET tasks/paginated
ivinayakg 92d66b1
API contract for GET /tasks queried
ivinayakg 26ce84d
requested changes done
ivinayakg bd6a8a4
Adding filter by query in the API
ivinayakg 7a3e3f6
Revert "requested changes done"
ivinayakg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,6 +42,7 @@ | |
| :--------------------------------: | :---------------: | | ||
| [GET /tasks](#get-tasks) | Returns all tasks | | ||
| [GET /tasks/self](#get-tasksself) | Returns all tasks of a user | | ||
| [GET /tasks/paginated](#get-taskspaginated) | Returns all tasks based on the query (paginated) | | ||
| [POST /tasks](#post-tasks) | Creates new task | | ||
| [PATCH /tasks/:id](#patch-tasksid) | Updates tasks | | ||
| [GET /tasks/:username](#get-tasksusername) | Returns all tasks of the user | | ||
|
@@ -114,6 +115,40 @@ Returns all the completed tasks of user if query `completed=true` is passed, els | |
- **Content:** `{ 'statusCode': 404, 'error': 'Not Found', 'message': 'User doesn't exist' }` | ||
- **Code:** 500 | ||
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }` | ||
|
||
|
||
## **GET /tasks/paginated** | ||
|
||
Returns all the tasks which are created after the ```<task_object>``` whose "id" would be passed in the query ```after```. The no. of returned documents is controlled by ```limit```again from the query which will also have a default. | ||
|
||
- **Params** | ||
None | ||
- **Query** | ||
_Required:_ limit=[number], after=[string(task id)] | ||
- **Body** | ||
None | ||
- **Headers** | ||
None | ||
- **Cookie** | ||
None | ||
- **Success Response:** | ||
- **Code:** 200 | ||
- **Content:** | ||
``` | ||
{ | ||
tasks : {<task_object>}[], | ||
total : {<task_object>}[] length, | ||
till : <task_object_id> | ||
|
||
} | ||
``` | ||
|
||
- **Error Response:** | ||
- **Code:** 500 | ||
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }` | ||
- **Code:** 404 | ||
- **Content:** `{ 'statusCode': 404, 'error': 'Not Found', 'message': 'limit or after undefined' }` | ||
- **Code:** 500 | ||
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }` | ||
|
||
## **GET /tasks/:username** | ||
|
||
|
@@ -222,4 +257,4 @@ Returns all tasks of the requested user. | |
- **Code:** 404 | ||
- **Content:** `{ 'statusCode': 404, 'error': 'Not Found', 'message': 'Task doesn't exist' }` | ||
- **Code:** 500 | ||
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }` | ||
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need to have a
paginated
path. Is there something else we can do here to make it implicit to handle pagination, e.g using query params?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right, i have decided to make that change, and will do that