feat: support remote specs with authentication#230
Merged
Conversation
- new cli param `--remote-spec-request-headers` /
`OPENAPI_REMOTE_SPEC_REQUEST_HEADERS`
- accepts a JSON object like `{[uri: string]: {name: string, value: string}[]}`
- I don't _love_ using JSON as a format for this, however at least
it's standardized and escaping values etc is well understood. By
using JSON I'm confident that there won't be any edge cases with
spaces or other separaters that would need handling with a format
like `<uri>:<name>:<value>`
- main use-case is for generating from remote specs that are behind some
format of request header based authentication (eg: private github
repos, GCP IAP proxy, etc)
- Previously I was having to `curl` these to the local filesystem
first, which is inconvenient
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
new cli param
--remote-spec-request-headers/OPENAPI_REMOTE_SPEC_REQUEST_HEADERSaccepts a JSON object like
{[uri: string]: {name: string, value: string} | {name: string, value: string}[]}it's standardized and escaping values etc is well understood. By
using JSON I'm confident that there won't be any edge cases with
spaces or other separaters that would need handling with a format
like
<uri>:<name>:<value>main use-case is for generating from remote specs that are behind some
format of request header based authentication (eg: private github
repos, GCP IAP proxy, etc)
curlthese to the local filesystemfirst, which is inconvenient
closes #229