Moved from Accept to Accept-Encoding header in secrets batch endpoint #2065
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
|
Code Climate has analyzed commit 61fc14bc and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 89.4% (0.0% change). View more on Code Climate. |
micahlee
suggested changes
Mar 11, 2021
|
@micahlee Updated the response headers and added a new check in the tests to ensure the header gets set |
micahlee
reviewed
Mar 11, 2021
The secrets batch endpoint used to look at the Accept header to determine if it should base64-encode the response. Now it looks at the Accept-Encoding header. This change falls in line better with the intended uses of both headers
This was referenced Mar 16, 2021
6 tasks
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 does this PR do?
When I first implemented this fix I chose to have the batch secrets retrieval endpoint check the
AcceptHeader, however after reading the RFC relating to the two headers and putting some thought into it I believe the header should be changed.I wanted to address this issue because currently it will be easy to update the integrations which use this header (only the Go client and OpenAPI spec), however left alone it will become an annoying piece of technical debt.
Checklists
Change log
Test coverage
Documentation
READMEs) were updated in this PR, and/or there is a follow-on issue to update docs, orAPI Changes
Related OpenAPI PR