Merge af624e593b into bf5fbc9945

Avoid superfluous MUST
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
2026-08-03 22:47:49 +02:00 · 2026-07-15 05:07:11 +00:00 · 2026-07-15 07:07:09 +02:00 · 2026-07-14 18:42:07 -04:00 · 2026-07-09 07:41:57 +02:00
5 changed files with 11 additions and 3 deletions
--- a/changelogs/client_server/newsfragments/2407.clarification
+++ b/changelogs/client_server/newsfragments/2407.clarification
@ -0,0 +1 @@
+Add further normative language in mutual rooms server behaviour.
--- a/changelogs/client_server/newsfragments/2412.clarification
+++ b/changelogs/client_server/newsfragments/2412.clarification
@ -0,0 +1 @@
+Use the User ID type in OlmPayload and DeviceKeys.
--- a/content/client-server-api/modules/mutual_rooms.md
+++ b/content/client-server-api/modules/mutual_rooms.md
@ -6,9 +6,9 @@

 #### Server behaviour

-The server may decide that the response to this endpoint is too large, and only return a
-subset of the results. In this case, the server should populate the optional field `next_batch`
-with an [opaque identifier](/appendices/#opaque-identifiers). The client may then supply
+The server MAY decide that the response to this endpoint is too large, and only return a
+subset of the results. In this case, the server populates the optional field `next_batch`
+with an [opaque identifier](/appendices/#opaque-identifiers). The client can then supply
 the identifier as the `from` query parameter in a subsequent request, along with the original
 `user_id`, to fetch the next batch of responses. This will continue until the server no longer
 inserts `next_batch`, meaning there are no further results.
--- a/data/api/client-server/definitions/device_keys.yaml
+++ b/data/api/client-server/definitions/device_keys.yaml
@ -20,6 +20,8 @@ properties:
    description: |-
      The ID of the user the device belongs to. Must match the user ID used
      when logging in.
+    format: mx-user-id
+    pattern: "^@"
    example: "@alice:example.com"
  device_id:
    type: string
--- a/data/api/client-server/definitions/olm_payload.yaml
+++ b/data/api/client-server/definitions/olm_payload.yaml
@ -27,9 +27,13 @@ properties:
  sender:
    type: string
    description: The user ID of the event sender.
+    format: mx-user-id
+    pattern: "^@"
  recipient:
    type: string
    description: The user ID of the intended event recipient.
+    format: mx-user-id
+    pattern: "^@"
  recipient_keys:
    description: The recipient's signing keys of the encrypted event.
    $ref: "#/components/schemas/SigningKeys"
Author	SHA1	Message	Date
Johannes Marbach	61f7a6765f	Merge `af624e593b` into `bf5fbc9945`	2026-07-15 05:07:11 +00:00
Johannes Marbach	af624e593b	Avoid superfluous MUST Co-authored-by: Hubert Chathi <hubertc@matrix.org>	2026-07-15 07:07:09 +02:00
gewitternacht	bf5fbc9945	use User ID type in OlmPayload and DeviceKeys (#2412 ) Some checks are pending Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run Details Spec / 🔎 Check Event schema examples (push) Waiting to run Details Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run Details Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run Details Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run Details Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions Details Spec / 📢 Run towncrier for changelog (push) Waiting to run Details Spec / 📖 Build the spec (push) Blocked by required conditions Details Spec / 🔎 Validate generated HTML (push) Blocked by required conditions Details Spec / 📖 Build the historical backup spec (push) Blocked by required conditions Details Spec / Create release (push) Blocked by required conditions Details Spell Check / Spell Check with Typos (push) Waiting to run Details * use User ID type in OlmPayload and DeviceKeys Signed-off-by: Johanna Stuber <johannas@element.io> * add newsfragment Signed-off-by: Johanna Stuber <johannas@element.io> --------- Signed-off-by: Johanna Stuber <johannas@element.io>	2026-07-14 18:42:07 -04:00
Johannes Marbach	4d310046a1	Add further normative language in mutual rooms server behaviour Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>	2026-07-09 07:41:57 +02:00
				`@ -0,0 +1 @@`
				`Add further normative language in mutual rooms server behaviour.`
				`@ -0,0 +1 @@`
				`Use the User ID type in OlmPayload and DeviceKeys.`