Clarify what key content-specific rules match against. (#1441)

This commit is contained in:
Patrick Cloke 2023-03-08 08:06:06 -05:00 committed by GitHub
parent b441b19cc3
commit afae1083aa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 26 additions and 20 deletions

View file

@ -34,8 +34,8 @@ properties:
pattern:
type: string
description: |-
Required for `event_match` conditions. The glob-style pattern to
match against.
Required for `event_match` conditions. The [glob-style pattern](/appendices#glob-style-matching)
to match against.
is:
type: string
description: |-

View file

@ -46,8 +46,8 @@ properties:
pattern:
type: string
description: |-
The glob-style pattern to match against. Only applicable to `content`
rules.
The [glob-style pattern](/appendices#glob-style-matching) to match against.
Only applicable to `content` rules.
required:
- actions
- default

View file

@ -7,8 +7,8 @@ description: |-
server ACL. Servers that do not uphold the ACLs MUST be added to the denied hosts
list in order for the ACLs to remain effective.
The `allow` and `deny` lists are lists of globs supporting `?` and `*`
as wildcards. When comparing against the server ACLs, the suspect server's port
The `allow` and `deny` lists are lists of [glob-style patterns](/appendices#glob-style-matching).
When comparing against the server ACLs, the suspect server's port
number must not be considered. Therefore `evil.com`, `evil.com:8448`, and
`evil.com:1234` would all match rules that apply to `evil.com`, for example.
@ -61,8 +61,7 @@ properties:
type: array
description: |-
The server names to allow in the room, excluding any port information.
Wildcards may be used to cover a wider range of hosts, where `*`
matches zero or more characters and `?` matches exactly one character.
Each entry is interpreted as a [glob-style pattern](/appendices#glob-style-matching).
**This defaults to an empty list when not provided, effectively disallowing
every server.**
@ -72,8 +71,7 @@ properties:
type: array
description: |-
The server names to disallow in the room, excluding any port information.
Wildcards may be used to cover a wider range of hosts, where `*`
matches zero or more characters and `?` matches exactly one character.
Each entry is interpreted as a [glob-style pattern](/appendices#glob-style-matching).
This defaults to an empty list when not provided.
items: