added a doc string to get-list-details function #240
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
|
Thanks for the PR |
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.
What type of PR is this?
Related Issue :
#219
What does this PR do ?
The essence of this pull request lies in fortifying the documentation for the get_list_details endpoint by embedding a detailed docstring. This docstring delves into the intricacies of the endpoint, elucidating its overarching purpose, input parameters, output composition, and potential error scenarios. Furthermore, it includes an illustrative response snippet to elucidate the expected outcome.
Consideration :
I take into consideration:
Prioritizing clarity and comprehensiveness in the documentation to facilitate understanding of the endpoint's functionality and behavior.
How to test ?
To test this enhancement:
Visist http://127.0.0.1:8000/v1/docs