Provide response headers to all API methods #469
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
tjoubert
added
enhancement
DiscoPYF
reviewed
Feb 6, 2023
There was a problem hiding this comment.
This PR contains two related but different changesets:
- Allow specifying request headers for all API endpoints
- A proposed solution to expose response headers by standardizing the return type of all API endpoints
Can you split them into their own PR? It will be much easier to review and update.
For example, the request header changes are much simpler and may be merged faster, wheareas the response changes may have more discussions/questions.
|
Got it 👍 This pull request appears to be based on the commits from #467 but I'm not sure that's really needed. Anyway, I'll review that other one first then. |
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.
ApiClientBase.GetResponseAsync()to extract the response body and headers to an object of typeApiResponse<T>whereTis the response type.ApiClientBase.GetApiErrorExceptionAsync()to extract header values on error and assign that toApiErrorException.Headers(a new dictionary property).ViewsApiClient.GetAllViewsAsync()to return an object of typeApiResponse<GetAllViewsResponse>instead ofGetAllViewsResponseas it was before. TheApiResponsehas aHeadersdictionary property and will also contain any other data that we want to pass for all responses in the future.ViewsApiClient.GetAllViewsAsync()will be applied to all other API client methods. This is a major breaking change because we are changing the return values of all methods.The intent is to release this as part of v2.0.0 in February 2023.