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

Merge branch 'master' into module-im

Browse source
This commit is contained in:
Kegan Dougal 2015-10-07 10:48:52 +01:00
commit c47fb12aed
4 changed files with 42 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
api/client-server/v2_alpha/core-event-schema Symbolic link
View file

@ -0,0 +1 @@
../../../event-schemas/schema/v1/core-event-schema

10
api/client-server/v2_alpha/definitions/error.yaml Normal file
View file

@ -0,0 +1,10 @@
type: object
description: A Matrix-level Error
properties:
errcode:
type: string
description: An error code.
error:
type: string
description: A human-readable error message.
required: ["errcode"]

3
api/client-server/v2_alpha/receipts.yaml
View file

@ -47,6 +47,7 @@ paths:
required: true required: true
x-example: "$1924376522eioj:example.com" x-example: "$1924376522eioj:example.com"
- in: body - in: body
name: receipt
description: |- description: |-
Extra receipt information to attach to ``content`` if any. The Extra receipt information to attach to ``content`` if any. The
server will automatically set the ``ts`` field. server will automatically set the ``ts`` field.
@ -65,4 +66,4 @@ paths:
429: 429:
description: This request was rate-limited. description: This request was rate-limited.
schema: schema:
"$ref": "definitions/error.yaml" "$ref": "definitions/error.yaml"

29
api/client-server/v2_alpha/sync.yaml
View file

@ -72,36 +72,49 @@ paths:
The batch token to supply in the ``since`` param of the next The batch token to supply in the ``since`` param of the next
``/sync`` request. ``/sync`` request.
rooms: rooms:
title: Rooms
type: object type: object
description: |- description: |-
Updates to rooms. Updates to rooms.
properties: properties:
joined: joined:
title: Joined
type: object type: object
additionalProperties: additionalProperties:
title: Joined Room
type: object type: object
properties: properties:
event_map: event_map:
title: EventMap
type: object type: object
description: |- description: |-
A map from event ID to events for this room. The A map from event ID to events for this room. The
events are referenced from the ``timeline`` and events are referenced from the ``timeline`` and
``state`` keys for this room. ``state`` keys for this room.
additionalProperties: additionalProperties:
title: Event
description: An event object. description: An event object.
type: object type: object
allOf:
- $ref: "core-event-schema/event.json"
state: state:
title: State
type: object
description: |- description: |-
The state updates for the room. The state updates for the room.
allOf: allOf:
- $ref: "definitions/room_event_batch.json" - $ref: "definitions/room_event_batch.json"
timeline: timeline:
title: Timeline
type: object
description: |- description: |-
The timeline of messages and state changes in the The timeline of messages and state changes in the
room. room.
allOf: allOf:
- $ref: "definitions/timeline_batch.json" - $ref: "definitions/timeline_batch.json"
ephemeral: ephemeral:
title: Ephemeral
type: object
description: |- description: |-
The ephemeral events in the room that aren't The ephemeral events in the room that aren't
recorded in the timeline or state of the room. recorded in the timeline or state of the room.
@ -109,13 +122,17 @@ paths:
allOf: allOf:
- $ref: "definitions/event_batch.json" - $ref: "definitions/event_batch.json"
invited: invited:
title: Invited
type: object type: object
description: |- description: |-
The rooms that the user has been invited to. The rooms that the user has been invited to.
additionalProperties: additionalProperties:
title: Invited Room
type: object type: object
properties: properties:
invite_state: invite_state:
title: InviteState
type: object
description: |- description: |-
The state of a room that the user has been invited The state of a room that the user has been invited
to. These state events may only have the `sender``, to. These state events may only have the `sender``,
@ -132,35 +149,47 @@ paths:
allOf: allOf:
- $ref: "definitions/event_batch.json" - $ref: "definitions/event_batch.json"
archived: archived:
title: Archived
type: object type: object
description: |- description: |-
The rooms that the user has left or been banned from. The The rooms that the user has left or been banned from. The
entries in the room_map will lack an ``ephemeral`` key. entries in the room_map will lack an ``ephemeral`` key.
additionalProperties: additionalProperties:
title: Archived Room
type: object type: object
properties: properties:
event_map: event_map:
title: EventMap
type: object type: object
description: |- description: |-
A map from event ID to events for this room. The A map from event ID to events for this room. The
events are referenced from the ``timeline`` and events are referenced from the ``timeline`` and
``state`` keys for this room. ``state`` keys for this room.
additionalProperties: additionalProperties:
title: Event
description: An event object. description: An event object.
type: object type: object
allOf:
- $ref: "core-event-schema/event.json"
state: state:
title: State
type: object
description: |- description: |-
The state updates for the room up to the point when The state updates for the room up to the point when
the user left. the user left.
allOf: allOf:
- $ref: "definitions/room_event_batch.json" - $ref: "definitions/room_event_batch.json"
timeline: timeline:
title: Timeline
type: object
description: |- description: |-
The timeline of messages and state changes in the The timeline of messages and state changes in the
room up to the point when the user left. room up to the point when the user left.
allOf: allOf:
- $ref: "definitions/timeline_batch.json" - $ref: "definitions/timeline_batch.json"
presence: presence:
title: Presence
type: object
description: |- description: |-
The updates to the presence status of other users. The updates to the presence status of other users.
allOf: allOf: