doc: update HeadersPolicy documentation #2467
Merged
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
|
I'm also thinking that we should fold the section titled "Proxy to external resource" in to the extenalname section. LMK. |
jpeach
force-pushed
the
doc-header-rewrite
branch
from
c820120
to
3742114
Compare
Update the API reference for `HeadersPolicy` to clarfy the semantics of setting headers and to mention the special treatment of the `Host` header. Rewrite the primary HTTPProxy guide to document that general header rewriting is available in the `HeadersPolicy` fields. This fixes projectcontour#2462. Signed-off-by: James Peach <jpeach@vmware.com>
jpeach
force-pushed
the
doc-header-rewrite
branch
from
3742114
to
202ba8b
Compare
Codecov Report
@@ Coverage Diff @@
## master #2467 +/- ##
==========================================
+ Coverage 76.72% 76.76% +0.03%
==========================================
Files 68 68
Lines 5522 5522
==========================================
+ Hits 4237 4239 +2
+ Misses 1188 1187 -1
+ Partials 97 96 -1
Continue to review full report at Codecov.
|
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.
Update the API reference for
HeadersPolicyto clarfy the semantics ofsetting headers and to mention the special treatment of the
Hostheader.Rewrite the primary HTTPProxy guide to document that general header
rewriting is available in the
HeadersPolicyfields.This fixes #2462.
Signed-off-by: James Peach jpeach@vmware.com