diff options
| author | Matthew Holt <mholt@users.noreply.github.com> | 2020-02-14 11:00:46 -0700 |
|---|---|---|
| committer | Matthew Holt <mholt@users.noreply.github.com> | 2020-02-14 11:01:09 -0700 |
| commit | 2cc5d2227dd8b8ad2d71112709ec29ab34fcd0ea (patch) | |
| tree | 23756a2e0daa636b7d9ed9fcc61c42242f5382f1 /modules/caddyhttp | |
| parent | 15bf9c196c5972051f40ebadf50811bd06e328dd (diff) | |
Minor tweaks to docs/comments
Diffstat (limited to 'modules/caddyhttp')
| -rw-r--r-- | modules/caddyhttp/matchers.go | 7 | ||||
| -rw-r--r-- | modules/caddyhttp/server.go | 17 |
2 files changed, 13 insertions, 11 deletions
diff --git a/modules/caddyhttp/matchers.go b/modules/caddyhttp/matchers.go index 552aa91..3b890d9 100644 --- a/modules/caddyhttp/matchers.go +++ b/modules/caddyhttp/matchers.go @@ -72,7 +72,12 @@ type ( // MatchQuery matches requests by URI's query string. MatchQuery url.Values - // MatchHeader matches requests by header fields. + // MatchHeader matches requests by header fields. It performs fast, + // exact string comparisons of the field values. Fast prefix, suffix, + // and substring matches can also be done by suffixing, prefixing, or + // surrounding the value with the wildcard `*` character, respectively. + // If a list is null, the header must not exist. If the list is empty, + // the field must simply exist, regardless of its value. MatchHeader http.Header // MatchHeaderRE matches requests by a regular expression on header fields. diff --git a/modules/caddyhttp/server.go b/modules/caddyhttp/server.go index 1c896a4..124331d 100644 --- a/modules/caddyhttp/server.go +++ b/modules/caddyhttp/server.go @@ -324,16 +324,13 @@ type HTTPErrorConfig struct { // chain returns an error. In an error route, extra // placeholders are available: // - // {http.error.status_code} - // The recommended HTTP status code - // {http.error.status_text} - // The status text associated with the recommended status code - // {http.error.message} - // The error message - // {http.error.trace} - // The origin of the error - // {http.error.id} - // A short, human-conveyable ID for the error + // Placeholder | Description + // ------------|--------------- + // `{http.error.status_code}` | The recommended HTTP status code + // `{http.error.status_text}` | The status text associated with the recommended status code + // `{http.error.message}` | The error message + // `{http.error.trace}` | The origin of the error + // `{http.error.id}` | An identifier for this occurrence of the error Routes RouteList `json:"routes,omitempty"` } |