Infrastructure/caddy
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-01-20 22:52:58 -05:00
Code Issues Activity

docs: Clarify "not" matcher structure (see #3233)

Browse source
This commit is contained in:
Matthew Holt 2020-04-06 18:44:12 -06:00
parent 7be747fbe9
commit 657f0cab17
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
modules/caddyhttp/matchers.go
View file

@ -114,6 +114,20 @@ type (
// true, the final result of the "not" matcher is false. Individual // true, the final result of the "not" matcher is false. Individual
// matchers within a set work the same (i.e. different matchers in // matchers within a set work the same (i.e. different matchers in
// the same set are AND'ed). // the same set are AND'ed).
//
// Note that the generated docs which describe the structure of
// this module are wrong because of how this type unmarshals JSON
// in a custom way. The correct structure is:
//
// ```json
// [
// {},
// {}
// ]
// ```
//
// where each of the array elements is a matcher set, i.e. an
// object keyed by matcher name.
MatchNot struct { MatchNot struct {
MatcherSetsRaw []caddy.ModuleMap `json:"-" caddy:"namespace=http.matchers"` MatcherSetsRaw []caddy.ModuleMap `json:"-" caddy:"namespace=http.matchers"`
MatcherSets []MatcherSet `json:"-"` MatcherSets []MatcherSet `json:"-"`