|
|
|
|
@ -60,96 +60,102 @@ paths:
|
|
|
|
|
x-example: ["1", "2"]
|
|
|
|
|
responses:
|
|
|
|
|
200:
|
|
|
|
|
description: |-
|
|
|
|
|
An unsigned event that the server may now use as a template
|
|
|
|
|
for the rest of the `Joining Rooms`_ handshake.
|
|
|
|
|
description:
|
|
|
|
|
A template to be used for the rest of the `Joining Rooms`_ handshake.
|
|
|
|
|
schema:
|
|
|
|
|
allOf:
|
|
|
|
|
- $ref: "definitions/unsigned_pdu.yaml"
|
|
|
|
|
- type: object
|
|
|
|
|
properties:
|
|
|
|
|
# Note: we override a bunch of parameters to change their descriptions
|
|
|
|
|
sender:
|
|
|
|
|
type: string
|
|
|
|
|
description: The user ID of the joining member.
|
|
|
|
|
example: "@someone:example.org"
|
|
|
|
|
origin:
|
|
|
|
|
type: string
|
|
|
|
|
description: The name of the resident homeserver.
|
|
|
|
|
example: "matrix.org"
|
|
|
|
|
origin_server_ts:
|
|
|
|
|
type: integer
|
|
|
|
|
format: int64
|
|
|
|
|
description: A timestamp added by the resident homeserver.
|
|
|
|
|
example: 1234567890
|
|
|
|
|
type:
|
|
|
|
|
type: string
|
|
|
|
|
description: The value ``m.room.member``.
|
|
|
|
|
example: "m.room.member"
|
|
|
|
|
state_key:
|
|
|
|
|
type: string
|
|
|
|
|
description: The user ID of the joining member.
|
|
|
|
|
example: "@someone:example.org"
|
|
|
|
|
content:
|
|
|
|
|
type: object
|
|
|
|
|
properties:
|
|
|
|
|
event:
|
|
|
|
|
allOf:
|
|
|
|
|
- $ref: "definitions/unsigned_pdu.yaml"
|
|
|
|
|
- description: |-
|
|
|
|
|
An unsigned template event.
|
|
|
|
|
type: object
|
|
|
|
|
title: Membership Event Content
|
|
|
|
|
description: The content of the event.
|
|
|
|
|
example: {"membership": "join"}
|
|
|
|
|
properties:
|
|
|
|
|
membership:
|
|
|
|
|
# Note: we override a bunch of parameters to change their descriptions
|
|
|
|
|
sender:
|
|
|
|
|
type: string
|
|
|
|
|
description: The value ``join``.
|
|
|
|
|
example: "join"
|
|
|
|
|
required: ['membership']
|
|
|
|
|
depth:
|
|
|
|
|
type: integer
|
|
|
|
|
description: This field must be present but is ignored; it may be 0.
|
|
|
|
|
example: 12
|
|
|
|
|
auth_events:
|
|
|
|
|
type: array
|
|
|
|
|
description: |-
|
|
|
|
|
An event reference list containing the authorization events that would
|
|
|
|
|
allow the member to join the room. This should normally be the
|
|
|
|
|
``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules``
|
|
|
|
|
events.
|
|
|
|
|
items:
|
|
|
|
|
type: array
|
|
|
|
|
maxItems: 2
|
|
|
|
|
minItems: 2
|
|
|
|
|
items:
|
|
|
|
|
- type: string
|
|
|
|
|
title: Event ID
|
|
|
|
|
example: "$abc123:matrix.org"
|
|
|
|
|
- type: object
|
|
|
|
|
title: Event Hash
|
|
|
|
|
example: {
|
|
|
|
|
"sha256": "abase64encodedsha256hashshouldbe43byteslong"
|
|
|
|
|
}
|
|
|
|
|
properties:
|
|
|
|
|
sha256:
|
|
|
|
|
type: string
|
|
|
|
|
description: The event hash.
|
|
|
|
|
example: abase64encodedsha256hashshouldbe43byteslong
|
|
|
|
|
required: ['sha256']
|
|
|
|
|
redacts:
|
|
|
|
|
type: string
|
|
|
|
|
description: Not used.
|
|
|
|
|
required:
|
|
|
|
|
# Every other field is already flagged as required by the $ref
|
|
|
|
|
- state_key
|
|
|
|
|
description: The user ID of the joining member.
|
|
|
|
|
example: "@someone:example.org"
|
|
|
|
|
origin:
|
|
|
|
|
type: string
|
|
|
|
|
description: The name of the resident homeserver.
|
|
|
|
|
example: "matrix.org"
|
|
|
|
|
origin_server_ts:
|
|
|
|
|
type: integer
|
|
|
|
|
format: int64
|
|
|
|
|
description: A timestamp added by the resident homeserver.
|
|
|
|
|
example: 1234567890
|
|
|
|
|
type:
|
|
|
|
|
type: string
|
|
|
|
|
description: The value ``m.room.member``.
|
|
|
|
|
example: "m.room.member"
|
|
|
|
|
state_key:
|
|
|
|
|
type: string
|
|
|
|
|
description: The user ID of the joining member.
|
|
|
|
|
example: "@someone:example.org"
|
|
|
|
|
content:
|
|
|
|
|
type: object
|
|
|
|
|
title: Membership Event Content
|
|
|
|
|
description: The content of the event.
|
|
|
|
|
example: {"membership": "join"}
|
|
|
|
|
properties:
|
|
|
|
|
membership:
|
|
|
|
|
type: string
|
|
|
|
|
description: The value ``join``.
|
|
|
|
|
example: "join"
|
|
|
|
|
required: ['membership']
|
|
|
|
|
depth:
|
|
|
|
|
type: integer
|
|
|
|
|
description: This field must be present but is ignored; it may be 0.
|
|
|
|
|
example: 12
|
|
|
|
|
auth_events:
|
|
|
|
|
type: array
|
|
|
|
|
description: |-
|
|
|
|
|
An event reference list containing the authorization events that would
|
|
|
|
|
allow the member to join the room. This should normally be the
|
|
|
|
|
``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules``
|
|
|
|
|
events.
|
|
|
|
|
items:
|
|
|
|
|
type: array
|
|
|
|
|
maxItems: 2
|
|
|
|
|
minItems: 2
|
|
|
|
|
items:
|
|
|
|
|
- type: string
|
|
|
|
|
title: Event ID
|
|
|
|
|
example: "$abc123:matrix.org"
|
|
|
|
|
- type: object
|
|
|
|
|
title: Event Hash
|
|
|
|
|
example: {
|
|
|
|
|
"sha256": "abase64encodedsha256hashshouldbe43byteslong"
|
|
|
|
|
}
|
|
|
|
|
properties:
|
|
|
|
|
sha256:
|
|
|
|
|
type: string
|
|
|
|
|
description: The event hash.
|
|
|
|
|
example: abase64encodedsha256hashshouldbe43byteslong
|
|
|
|
|
required: ['sha256']
|
|
|
|
|
redacts:
|
|
|
|
|
type: string
|
|
|
|
|
description: Not used.
|
|
|
|
|
required:
|
|
|
|
|
# Every other field is already flagged as required by the $ref
|
|
|
|
|
- state_key
|
|
|
|
|
examples:
|
|
|
|
|
application/json: {
|
|
|
|
|
"$ref": "examples/unsigned_pdu.json",
|
|
|
|
|
"type": "m.room.member",
|
|
|
|
|
"state_key": "@someone:example.org",
|
|
|
|
|
"content": {
|
|
|
|
|
event: {
|
|
|
|
|
"$ref": "examples/unsigned_pdu.json",
|
|
|
|
|
"type": "m.room.member",
|
|
|
|
|
"state_key": "@someone:example.org",
|
|
|
|
|
"content": {
|
|
|
|
|
"membership": "join"
|
|
|
|
|
},
|
|
|
|
|
"auth_events": [
|
|
|
|
|
["$room_cre4te_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
|
|
|
|
|
["$room_j0in_rul3s_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
|
|
|
|
|
["$room_p0wer_l3vels_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}]
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"auth_events": [
|
|
|
|
|
["$room_cre4te_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
|
|
|
|
|
["$room_j0in_rul3s_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
|
|
|
|
|
["$room_p0wer_l3vels_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}]
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
400:
|
|
|
|
|
description: |-
|
|
|
|
|
|
Richard van der Hoff
6 years ago