matrix-spec/redocly.yaml

# See https://redocly.com/docs/cli/configuration/ for more information.
extends:
  - recommended-strict
rules:
  info-license: off
  security-defined: off
  operation-4xx-response: off
  no-invalid-media-type-examples: off
  no-path-trailing-slash: off
  operation-2xx-response: off
  spec-strict-refs: error
  # $ref in examples are not spec-compliant, yet we find them useful. Disable this rule
  # and instead check example schema using `check-event-schema-examples.py`
  no-invalid-schema-examples: off
Use Redocly CLI to validate OpenAPI definitions (#1558) 2023-06-09 20:55:12 +02:00			`# See https://redocly.com/docs/cli/configuration/ for more information.`
			`extends:`
Simplify uses of `resolve-refs` partial (#1773) * Use the resolve-refs partial as soon as possible Call it right after accessing the site.Data, since it is recursing it will solve all references in the tree. That way we don't need to wonder where to call it, we trust the validators that the refs will be used in the right place. * Enable strict $ref rule in OpenAPI validator * Document use of $ref to compose examples * Fix schema path in event-fields shortcode Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> 2024-04-09 19:06:53 +02:00			`- recommended-strict`
Use Redocly CLI to validate OpenAPI definitions (#1558) 2023-06-09 20:55:12 +02:00			`rules:`
			`info-license: off`
			`security-defined: off`
			`operation-4xx-response: off`
			`no-invalid-media-type-examples: off`
			`no-path-trailing-slash: off`
Simplify uses of `resolve-refs` partial (#1773) * Use the resolve-refs partial as soon as possible Call it right after accessing the site.Data, since it is recursing it will solve all references in the tree. That way we don't need to wonder where to call it, we trust the validators that the refs will be used in the right place. * Enable strict $ref rule in OpenAPI validator * Document use of $ref to compose examples * Fix schema path in event-fields shortcode Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> 2024-04-09 19:06:53 +02:00			`operation-2xx-response: off`
Silence redocly-cli rule checking examples (#2238) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> 2025-10-24 12:19:19 +02:00			`spec-strict-refs: error`
			`# $ref in examples are not spec-compliant, yet we find them useful. Disable this rule`
			# and instead check example schema using `check-event-schema-examples.py`
			`no-invalid-schema-examples: off`