Implemented: code to define success response schema(#85zrhhcgr) #47
Conversation
This file contains 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
adityasharma7
suggested changes
Jan 9, 2023
src/types/index.ts
Outdated
| interface SuccessResponse<Type> { | ||
| list: Type[]; | ||
| count: { | ||
| [x: string]: number; |
There was a problem hiding this comment.
We should have attributes in count
There was a problem hiding this comment.
Added total and groups attributes at root of schema.
ymaheshwari1
changed the title
…ndexable types from the schema, also added the total, groups property at root(#85zrhhcgr)
adityasharma7
suggested changes
Jan 10, 2023
src/types/index.ts
Outdated
| @@ -39,6 +39,12 @@ interface Response { | |||
| serverResponse?: any; | |||
| } | |||
|
|
|||
| interface SuccessResponse<Type> { | |||
There was a problem hiding this comment.
We should define practices for list and object responses, and name accordingly
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related Issues
Closes #38
Short Description and Why It's Useful
Added two different approaches for defining schema
Defined an interface using generics, so as the same can be directly used for different type of success responses. Also added another property as object
countthat contains indexable types to contains different types of count like total (for total number of products), matches (in case when we are fetching resps as groups).2.) By extending interface
Screenshots of Visual Changes before/after (If There Are Any)
Contribution and Currently Important Rules Acceptance