archive
/
matrix-spec-proposals
mirror of https://github.com/matrix-org/matrix-spec-proposals
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Full stops

Browse Source
pull/1413/head
Travis Ralston 6 years ago
parent 797aca87bd
commit eaf175056f
3 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File

20
api/server-server/definitions/invite_event.yaml
Unescape Escape View File

@ -23,43 +23,43 @@ allOf:
type: string type: string
# TODO: Verify/clarify this - it doesn't seem right, given this is a 'regular' invite # TODO: Verify/clarify this - it doesn't seem right, given this is a 'regular' invite
description: |- description: |-
The matrix ID of the user who sent the original ``m.room.third_party_invite`` The matrix ID of the user who sent the original ``m.room.third_party_invite``.
example: "@someone:example.org" example: "@someone:example.org"
origin: origin:
type: string type: string
description: The name of the inviting homeserver description: The name of the inviting homeserver.
example: "matrix.org" example: "matrix.org"
origin_server_ts: origin_server_ts:
type: integer type: integer
format: int64 format: int64
description: A timestamp added by the inviting homeserver description: A timestamp added by the inviting homeserver.
example: 1234567890 example: 1234567890
type: type:
type: string type: string
description: The value ``m.room.member`` description: The value ``m.room.member``.
example: "m.room.member" example: "m.room.member"
state_key: state_key:
type: string type: string
description: The user ID of the invited member description: The user ID of the invited member.
example: "@joe:elsewhere.com" example: "@joe:elsewhere.com"
content: content:
type: object type: object
title: Membership Event Content title: Membership Event Content
description: |- description: |-
The content of the event, matching what is available in the The content of the event, matching what is available in the
`Client-Server API`_ `Client-Server API`_.
example: {"membership": "invite"} example: {"membership": "invite"}
properties: properties:
membership: membership:
type: string type: string
description: The value ``invite`` description: The value ``invite``.
example: "invite" example: "invite"
required: ['membership'] required: ['membership']
auth_events: auth_events:
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 be invited to the room allow the member to be invited to the room.
items: items:
type: array type: array
maxItems: 2 maxItems: 2
@ -76,12 +76,12 @@ allOf:
properties: properties:
sha256: sha256:
type: string type: string
description: The event hash description: The event hash.
example: abase64encodedsha256hashshouldbe43byteslong example: abase64encodedsha256hashshouldbe43byteslong
required: ['sha256'] required: ['sha256']
redacts: redacts:
type: string type: string
description: Not used description: Not used.
required: required:
# Every other field is already flagged as required by the $ref # Every other field is already flagged as required by the $ref
- state_key - state_key

6
api/server-server/invites.yaml
Unescape Escape View File

@ -35,13 +35,13 @@ paths:
- in: path - in: path
name: roomId name: roomId
type: string type: string
description: The room ID that the user is being invited to description: The room ID that the user is being invited to.
required: true required: true
x-example: "!abc123:matrix.org" x-example: "!abc123:matrix.org"
- in: path - in: path
name: eventId name: eventId
type: string type: string
description: The event ID for the invite event description: The event ID for the invite event.
required: true required: true
x-example: "$abc123:example.org" x-example: "$abc123:example.org"
- in: body - in: body
@ -70,7 +70,7 @@ paths:
maxItems: 2 maxItems: 2
items: items:
- type: integer - type: integer
description: The value ``200`` description: The value ``200``.
example: 200 example: 200
- $ref: "definitions/invite_event.yaml" - $ref: "definitions/invite_event.yaml"
examples: examples:

60
api/server-server/joins.yaml
Unescape Escape View File

@ -35,13 +35,13 @@ paths:
- in: path - in: path
name: roomId name: roomId
type: string type: string
description: The room ID that is about to be joined description: The room ID that is about to be joined.
required: true required: true
x-example: "!abc123:matrix.org" x-example: "!abc123:matrix.org"
- in: path - in: path
name: userId name: userId
type: string type: string
description: The user ID the join event will be for description: The user ID the join event will be for.
required: true required: true
x-example: "@someone:example.org" x-example: "@someone:example.org"
responses: responses:
@ -57,29 +57,29 @@ paths:
# Note: we override a bunch of parameters to change their descriptions # Note: we override a bunch of parameters to change their descriptions
sender: sender:
type: string type: string
description: The user ID of the joining member description: The user ID of the joining member.
example: "@someone:example.org" example: "@someone:example.org"
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
description: A timestamp added by the resident homeserver description: A timestamp added by the resident homeserver.
example: 1234567890 example: 1234567890
type: type:
type: string type: string
description: The value ``m.room.member`` description: The value ``m.room.member``.
example: "m.room.member" example: "m.room.member"
state_key: state_key:
type: string type: string
description: The user ID of the joining member description: The user ID of the joining member.
example: "@someone:example.org" example: "@someone:example.org"
content: content:
type: object type: object
title: Membership Event Content title: Membership Event Content
description: The content of the event description: The content of the event.
example: {"membership": "join"} example: {"membership": "join"}
properties: properties:
membership: membership:
@ -89,13 +89,13 @@ paths:
required: ['membership'] required: ['membership']
depth: depth:
type: integer type: integer
description: This field must be present but is ignored; it may be 0 description: This field must be present but is ignored; it may be 0.
example: 12 example: 12
auth_events: auth_events:
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 allow the member to join the room.
items: items:
type: array type: array
maxItems: 2 maxItems: 2
@ -112,12 +112,12 @@ paths:
properties: properties:
sha256: sha256:
type: string type: string
description: The event hash description: The event hash.
example: abase64encodedsha256hashshouldbe43byteslong example: abase64encodedsha256hashshouldbe43byteslong
required: ['sha256'] required: ['sha256']
redacts: redacts:
type: string type: string
description: Not used description: Not used.
required: required:
# Every other field is already flagged as required by the $ref # Every other field is already flagged as required by the $ref
- state_key - state_key
@ -141,13 +141,13 @@ paths:
- in: path - in: path
name: roomId name: roomId
type: string type: string
description: The room ID that is about to be joined description: The room ID that is about to be joined.
required: true required: true
x-example: "!abc123:matrix.org" x-example: "!abc123:matrix.org"
- in: path - in: path
name: eventId name: eventId
type: string type: string
description: The event ID for the join event description: The event ID for the join event.
required: true required: true
x-example: "$abc123:example.org" x-example: "$abc123:example.org"
- in: body - in: body
@ -162,45 +162,45 @@ paths:
# Note: we override a bunch of parameters to change their descriptions # Note: we override a bunch of parameters to change their descriptions
sender: sender:
type: string type: string
description: The user ID of the joining member description: The user ID of the joining member.
example: "@someone:example.org" example: "@someone:example.org"
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
description: A timestamp added by the joining homeserver description: A timestamp added by the joining homeserver.
example: 1234567890 example: 1234567890
type: type:
type: string type: string
description: The value ``m.room.member`` description: The value ``m.room.member``.
example: "m.room.member" example: "m.room.member"
state_key: state_key:
type: string type: string
description: The user ID of the joining member description: The user ID of the joining member.
example: "@someone:example.org" example: "@someone:example.org"
content: content:
type: object type: object
title: Membership Event Content title: Membership Event Content
description: The content of the event description: The content of the event.
example: {"membership": "join"} example: {"membership": "join"}
properties: properties:
membership: membership:
type: string type: string
description: The value ``join`` description: The value ``join``.
example: "join" example: "join"
required: ['membership'] required: ['membership']
depth: depth:
type: integer type: integer
description: This field must be present but is ignored; it may be 0 description: This field must be present but is ignored; it may be 0.
example: 12 example: 12
auth_events: auth_events:
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 allow the member to join the room.
items: items:
type: array type: array
maxItems: 2 maxItems: 2
@ -217,12 +217,12 @@ paths:
properties: properties:
sha256: sha256:
type: string type: string
description: The event hash description: The event hash.
example: abase64encodedsha256hashshouldbe43byteslong example: abase64encodedsha256hashshouldbe43byteslong
required: ['sha256'] required: ['sha256']
redacts: redacts:
type: string type: string
description: Not used description: Not used.
required: required:
# Every other field is already flagged as required by the $ref # Every other field is already flagged as required by the $ref
- state_key - state_key
@ -237,29 +237,29 @@ paths:
responses: responses:
200: 200:
description: |- description: |-
The full state for the room, having accepted the join event The full state for the room, having accepted the join event.
schema: schema:
type: array type: array
minItems: 2 minItems: 2
maxItems: 2 maxItems: 2
items: items:
- type: integer - type: integer
description: The value ``200`` description: The value ``200``.
example: 200 example: 200
- type: object - type: object
title: Room State title: Room State
description: The state for the room description: The state for the room.
properties: properties:
auth_chain: auth_chain:
type: array type: array
description: The auth chain description: The auth chain.
items: items:
type: object type: object
properties: {} properties: {}
# TODO: Verify schema # TODO: Verify schema
state: state:
type: array type: array
description: The room state description: The room state.
items: items:
type: object type: object
properties: {} properties: {}

Write Preview
Loading…
Cancel
Save