Added documentation and examples for the ApiResponse<T> return type. #893
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
|
|
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 kind of change does this PR introduce?
Adds documentation about the
ApiResponse<T>return type and shows examples on how to retrieve response meta data (like response headers and status code) from this return type. I have added this documentation in response to the question I asked in the "Issues" section. This PR fixes #872What is the current behavior?
Documentation about this particular return type doesn't exist.
What is the new behavior?
Documentation for this return type has been added.
What might this PR break?
It won't break anything
Please check if the PR fulfills these requirements
Tests for the changes have been added (for bug fixes / features)Other information:
None