diff options
author | Matthew Holt <mholt@users.noreply.github.com> | 2020-04-06 18:44:12 -0600 |
---|---|---|
committer | Matthew Holt <mholt@users.noreply.github.com> | 2020-04-06 18:44:12 -0600 |
commit | 657f0cab17c1597f4f78f15d0b720aa6f9d7fbcb (patch) | |
tree | a3950b5f57ebf45635236b8db343886ab2d10c3b /modules | |
parent | 7be747fbe922573269cdaf83f15d1ec2245d257c (diff) |
docs: Clarify "not" matcher structure (see #3233)
Diffstat (limited to 'modules')
-rw-r--r-- | modules/caddyhttp/matchers.go | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/modules/caddyhttp/matchers.go b/modules/caddyhttp/matchers.go index 500495b..95100d5 100644 --- a/modules/caddyhttp/matchers.go +++ b/modules/caddyhttp/matchers.go @@ -114,6 +114,20 @@ type ( // true, the final result of the "not" matcher is false. Individual // matchers within a set work the same (i.e. different matchers in // 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 { MatcherSetsRaw []caddy.ModuleMap `json:"-" caddy:"namespace=http.matchers"` MatcherSets []MatcherSet `json:"-"` |