wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #1821 from matrix-org/travis/spec/rver-make-memberships

Browse source 
Specify the room_version response property on /make_{leave|join}
This commit is contained in:
Travis Ralston 2019-01-29 10:19:13 -07:00 • committed by GitHub
commit d2b35e5150
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
api/server-server/joins.yaml
View file

@ -65,6 +65,12 @@ paths:
schema: schema:
type: object type: object
properties: properties:
room_version:
type: string
description: |-
The version of the room where the server is trying to join. If not provided,
the room version is assumed to be either "1" or "2".
example: "2"
event: event:
allOf: allOf:
- $ref: "definitions/unsigned_pdu.yaml" - $ref: "definitions/unsigned_pdu.yaml"
@ -80,7 +86,7 @@ paths:
origin: origin:
type: string type: string
description: The name of the resident homeserver. description: The name of the resident homeserver.
example: "matrix.org" example: "matrix.org"
origin_server_ts: origin_server_ts:
type: integer type: integer
format: int64 format: int64
@ -113,7 +119,7 @@ paths:
type: array type: array
description: |- description: |-
An event reference list containing the authorization events that would An event reference list containing the authorization events that would
allow the member to join the room. This should normally be the allow the member to join the room. This should normally be the
``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules`` ``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules``
events. events.
items: items:
@ -143,7 +149,8 @@ paths:
- state_key - state_key
examples: examples:
application/json: { application/json: {
event: { "room_version": "2",
"event": {
"$ref": "examples/unsigned_pdu.json", "$ref": "examples/unsigned_pdu.json",
"type": "m.room.member", "type": "m.room.member",
"state_key": "@someone:example.org", "state_key": "@someone:example.org",
@ -220,7 +227,7 @@ paths:
origin: origin:
type: string type: string
description: The name of the joining homeserver. description: The name of the joining homeserver.
example: "matrix.org" example: "matrix.org"
origin_server_ts: origin_server_ts:
type: integer type: integer
format: int64 format: int64

11
api/server-server/leaving.yaml
View file

@ -57,6 +57,12 @@ paths:
schema: schema:
type: object type: object
properties: properties:
room_version:
type: string
description: |-
The version of the room where the server is trying to leave. If not provided,
the room version is assumed to be either "1" or "2".
example: "2"
event: event:
allOf: allOf:
- $ref: "definitions/unsigned_pdu.yaml" - $ref: "definitions/unsigned_pdu.yaml"
@ -101,7 +107,7 @@ paths:
type: array type: array
description: |- description: |-
An event reference list containing the authorization events that would An event reference list containing the authorization events that would
allow the member to leave the room. This should normally be the allow the member to leave the room. This should normally be the
``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules`` ``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules``
events. events.
items: items:
@ -131,6 +137,7 @@ paths:
- state_key - state_key
examples: examples:
application/json: { application/json: {
"room_version": "2",
"event": { "event": {
"$ref": "examples/unsigned_pdu.json", "$ref": "examples/unsigned_pdu.json",
"type": "m.room.member", "type": "m.room.member",
@ -194,7 +201,7 @@ paths:
origin: origin:
type: string type: string
description: The name of the leaving homeserver. description: The name of the leaving homeserver.
example: "matrix.org" example: "matrix.org"
origin_server_ts: origin_server_ts:
type: integer type: integer
format: int64 format: int64