From 74a0d5f289c0db13108596f8436b35f0c9bea05a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= <76261501+zecakeh@users.noreply.github.com> Date: Fri, 24 Oct 2025 12:19:19 +0200 Subject: [PATCH] Silence redocly-cli rule checking examples (#2238) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- changelogs/internal/newsfragments/2238.clarification | 1 + redocly.yaml | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 changelogs/internal/newsfragments/2238.clarification diff --git a/changelogs/internal/newsfragments/2238.clarification b/changelogs/internal/newsfragments/2238.clarification new file mode 100644 index 00000000..b91abc53 --- /dev/null +++ b/changelogs/internal/newsfragments/2238.clarification @@ -0,0 +1 @@ +Silence failing redocly-cli rule. diff --git a/redocly.yaml b/redocly.yaml index 28dda2db..294d2f10 100644 --- a/redocly.yaml +++ b/redocly.yaml @@ -8,4 +8,7 @@ rules: no-invalid-media-type-examples: off no-path-trailing-slash: off operation-2xx-response: off - spec-strict-refs: error \ No newline at end of file + 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