Fix CORS option documentation to match actual behavior#925
Merged
Conversation
The `--cors` flag documentation incorrectly stated it controls the value of `Access-Control-Allow-Origin`, when in reality it always sets it to '*'. The optional parameter value actually adds to `Access-Control-Allow-Headers`, not `Access-Control-Allow-Origin`. This commit corrects the documentation to accurately describe the behavior: - `--cors` enables CORS by setting `Access-Control-Allow-Origin` to '*' - `--cors='header1,header2'` adds custom headers to `Access-Control-Allow-Headers`
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.
The
--corsflag documentation incorrectly stated it controls the value ofAccess-Control-Allow-Origin, when in reality it always sets it to '*'. The optional parameter value actually adds toAccess-Control-Allow-Headers, notAccess-Control-Allow-Origin.This commit corrects the documentation to accurately describe the behavior:
--corsenables CORS by settingAccess-Control-Allow-Originto '*'--cors='header1,header2'adds custom headers toAccess-Control-Allow-HeadersRelevant issues
Fixes #856
Contributor checklist
--helpoutputmasterbranch