summaryrefslogtreecommitdiff
path: root/modules/caddyhttp
diff options
context:
space:
mode:
Diffstat (limited to 'modules/caddyhttp')
-rw-r--r--modules/caddyhttp/matchers.go14
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:"-"`