diff --git a/data/api/server-server/examples/stripped_state.json b/data/api/server-server/examples/stripped_state.json new file mode 100644 index 00000000..416d1958 --- /dev/null +++ b/data/api/server-server/examples/stripped_state.json @@ -0,0 +1,9 @@ +[ + {"$ref": "./minimal_pdu.json"}, + { + "type": "m.room.create", + "content": { + "see_room_version_spec": "The event format changes depending on the room version." + } + } +] \ No newline at end of file diff --git a/data/api/server-server/invites-v1.yaml b/data/api/server-server/invites-v1.yaml index 82edddf3..c8e411f6 100644 --- a/data/api/server-server/invites-v1.yaml +++ b/data/api/server-server/invites-v1.yaml @@ -85,10 +85,19 @@ paths: Servers might need to apply validation to the `invite_room_state` depending on room version. See the `400 M_MISSING_PARAM` error definition for more information. + + Note that events have a different format depending on the room + version - check the [room version specification](/rooms) for + precise event formats. items: - $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml + type: object + properties: {} + description: |- + Note that events have a different format depending on the room + version - check the [room version specification](/rooms) for + precise event formats. example: - $ref: ../../event-schemas/examples/invite_room_state.json + $ref: ./examples/stripped_state.json type: object required: true responses: @@ -129,35 +138,7 @@ paths: "origin_server_ts": 1549041175876, "sender": "@someone:example.org", "unsigned": { - "invite_room_state": [ - { - "type": "m.room.create", - "sender": "@bob:example.org", - "state_key": "", - "content": { - "version": "12" - }, - "remaining_fields": "are formatted according to the room version specification" - }, - { - "type": "m.room.name", - "sender": "@bob:example.org", - "state_key": "", - "content": { - "name": "Example Room" - }, - "remaining_fields": "are formatted according to the room version specification" - }, - { - "type": "m.room.join_rules", - "sender": "@bob:example.org", - "state_key": "", - "content": { - "join_rule": "invite" - }, - "remaining_fields": "are formatted according to the room version specification" - } - ] + "invite_room_state": {"$ref": "./examples/stripped_state.json"} }, "content": { "membership": "invite" diff --git a/data/api/server-server/invites-v2.yaml b/data/api/server-server/invites-v2.yaml index 743c88e8..fd6790f5 100644 --- a/data/api/server-server/invites-v2.yaml +++ b/data/api/server-server/invites-v2.yaml @@ -86,10 +86,19 @@ paths: Servers might need to apply validation to the `invite_room_state` depending on room version. See the `400 M_MISSING_PARAM` error definition for more information. + + Note that events have a different format depending on the room + version - check the [room version specification](/rooms) for + precise event formats. items: - $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml + type: object + properties: {} + description: |- + Note that events have a different format depending on the room + version - check the [room version specification](/rooms) for + precise event formats. example: - $ref: ../../event-schemas/examples/invite_room_state.json + $ref: ./examples/stripped_state.json required: - room_version - event @@ -122,35 +131,7 @@ paths: "origin_server_ts": 1549041175876, "sender": "@someone:example.org", "unsigned": { - "invite_room_state": [ - { - "type": "m.room.create", - "sender": "@bob:example.org", - "state_key": "", - "content": { - "version": "12" - }, - "remaining_fields": "are formatted according to the room version specification" - }, - { - "type": "m.room.name", - "sender": "@bob:example.org", - "state_key": "", - "content": { - "name": "Example Room" - }, - "remaining_fields": "are formatted according to the room version specification" - }, - { - "type": "m.room.join_rules", - "sender": "@bob:example.org", - "state_key": "", - "content": { - "join_rule": "invite" - }, - "remaining_fields": "are formatted according to the room version specification" - } - ] + "invite_room_state": {"$ref": "./examples/stripped_state.json"} }, "content": { "membership": "invite" diff --git a/data/api/server-server/knocks.yaml b/data/api/server-server/knocks.yaml index f0cf69ad..6994f609 100644 --- a/data/api/server-server/knocks.yaml +++ b/data/api/server-server/knocks.yaml @@ -293,7 +293,12 @@ paths: knock_room_state: type: array items: - $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml + type: object + properties: {} + description: |- + Note that events have a different format depending on the room + version - check the [room version specification](/rooms) for + precise event formats. x-changedInMatrixVersion: "1.16": | `m.room.create` and format requirements were added. @@ -309,15 +314,19 @@ paths: Entries which are [improperly signed](/server-server-api/#validating-hashes-and-signatures-on-received-events) or formatted SHOULD be removed by the server prior to supplying them over the Client-Server API. + + Note that events have a different format depending on the room + version - check the [room version specification](/rooms) for + precise event formats. example: - $ref: ../../event-schemas/examples/knock_room_state.json + "$ref": "./examples/stripped_state.json" required: - knock_room_state examples: response: value: { "knock_room_state": { - "$ref": "../../event-schemas/examples/knock_room_state.json" + "$ref": "./examples/stripped_state.json" } } "403":