Merge 19fa1c9cbf into 74a0d5f289

Silence redocly-cli rule checking examples (#2238 )
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2026-02-21 21:43:43 +01:00 · 2025-10-24 14:05:05 +02:00 · 2025-10-24 10:19:19 +00:00 · 2025-10-14 15:51:01 +02:00
3 changed files with 12 additions and 1 deletions
--- a/changelogs/internal/newsfragments/2238.clarification
+++ b/changelogs/internal/newsfragments/2238.clarification
@ -0,0 +1 @@
+Silence failing redocly-cli rule.
--- a/data/api/client-server/leaving.yaml
+++ b/data/api/client-server/leaving.yaml
@ -102,6 +102,13 @@ paths:
          example: "!au1ba7o:matrix.org"
          schema:
            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              example: {}
+        required: true
      responses:
        "200":
          description: The room has been forgotten.
--- 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
+  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
Author	SHA1	Message	Date
Harri	6886a39362	Merge `19fa1c9cbf` into `74a0d5f289`	2025-10-24 14:05:05 +02:00
Kévin Commaille	74a0d5f289	Silence redocly-cli rule checking examples (#2238 ) Some checks failed Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled Details Spec / 🔎 Check Event schema examples (push) Has been cancelled Details Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled Details Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled Details Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled Details Spec / 📢 Run towncrier for changelog (push) Has been cancelled Details Spell Check / Spell Check with Typos (push) Has been cancelled Details Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled Details Spec / 📖 Build the spec (push) Has been cancelled Details Spec / 🔎 Validate generated HTML (push) Has been cancelled Details Spec / 📖 Build the historical backup spec (push) Has been cancelled Details Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>	2025-10-24 10:19:19 +00:00
Harri	19fa1c9cbf	Fix schema for room forget call https://spec.matrix.org/v1.16/client-server-api/#post_matrixclientv3roomsroomidforget fails to define a request body. But it is not one of the four exceptions listed in https://spec.matrix.org/v1.16/client-server-api/#api-standards which deviate from the rule that > All POST and PUT endpoints, with the exception of those listed below, require the client to supply a request body containing a (potentially empty) JSON object.	2025-10-14 15:51:01 +02:00