Full stops, language.

pull/977/head
Travis Ralston 6 years ago
parent e226b60c7f
commit 89384c96c1

@ -22,16 +22,16 @@ example:
properties: properties:
edu_type: edu_type:
type: string type: string
description: The type of ephemeral message description: The type of ephemeral message.
example: "!abc123:matrix.org" example: "m.presence"
origin: origin:
type: string type: string
description: The server name sending the ephemeral message description: The server name sending the ephemeral message.
example: "matrix.org" example: "matrix.org"
destination: destination:
type: string type: string
description: The server name receiving the ephemeral message description: The server name receiving the ephemeral message.
example: "elsewhere.com" example: "elsewhere.com"
content: content:
type: object type: object
description: The content of the ephemeral message description: The content of the ephemeral message.

@ -23,20 +23,20 @@ allOf:
hashes: hashes:
type: object type: object
title: Event Hash title: Event Hash
description: Hashes of the PDU, following the algorithm specified in `Signing Events`_ description: Hashes of the PDU, following the algorithm specified in `Signing Events`_.
example: { example: {
"sha256": "thishashcoversallfieldsincasethisisredacted" "sha256": "thishashcoversallfieldsincasethisisredacted"
} }
properties: properties:
sha256: sha256:
type: string type: string
description: The hash description: The hash.
example: thishashcoversallfieldsincasethisisredacted example: thishashcoversallfieldsincasthisisredacted
required: ['sha256'] required: ['sha256']
signatures: signatures:
type: object type: object
description: |- description: |-
Signatures of the redacted PDU, following the algorithm specified in `Signing Events`_ Signatures of the redacted PDU, following the algorithm specified in `Signing Events`_.
example: { example: {
"example.com": { "example.com": {
"ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus" "ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus"

@ -20,16 +20,16 @@ properties:
origin: origin:
type: string type: string
description: |- description: |-
The ``server_name`` of hoemserver sending this transaction The ``server_name`` of the hoemserver sending this transaction.
example: "example.org" example: "example.org"
origin_server_ts: origin_server_ts:
type: integer type: integer
format: int64 format: int64
description: Timestamp in milliseconds on originating homeserver when this transaction started description: Timestamp in milliseconds on originating homeserver when this transaction started.
example: 1234567890 example: 1234567890
pdus: pdus:
type: array type: array
description: List of persistent updates to rooms description: List of persistent updates to rooms.
items: items:
$ref: "pdu.yaml" $ref: "pdu.yaml"
required: ['origin', 'origin_server_ts', 'pdus'] required: ['origin', 'origin_server_ts', 'pdus']

@ -19,15 +19,15 @@ example:
properties: properties:
room_id: room_id:
type: string type: string
description: Room identifier description: Room identifier.
example: "!abc123:matrix.org" example: "!abc123:matrix.org"
sender: sender:
type: string type: string
description: The ID of the user sending the event description: The ID of the user sending the event.
example: "@someone:matrix.org" example: "@someone:matrix.org"
origin: origin:
type: string type: string
description: The ``server_name`` of the homeserver that created this event description: The ``server_name`` of the homeserver that created this event.
example: "matrix.org" example: "matrix.org"
origin_server_ts: origin_server_ts:
type: integer type: integer
@ -47,13 +47,13 @@ properties:
example: "my_key" example: "my_key"
content: content:
type: object type: object
description: The content of the event description: The content of the event.
example: {"key": "value"} example: {"key": "value"}
prev_events: prev_events:
type: array type: array
description: |- description: |-
Event IDs and hashes of the most recent events in the room that the homeserver was aware Event IDs and hashes of the most recent events in the room that the homeserver was aware
of when it made this event of when it made this event.
items: items:
type: array type: array
maxItems: 2 maxItems: 2
@ -70,16 +70,16 @@ properties:
properties: properties:
sha256: sha256:
type: string type: string
description: The event hash description: The event hash.
example: abase64encodedsha256hashshouldbe43byteslong example: abase64encodedsha256hashshouldbe43byteslong
required: ['sha256'] required: ['sha256']
depth: depth:
type: integer type: integer
description: The maximum depth of the ``prev_events``, plus one description: The maximum depth of the ``prev_events``, plus one.
example: 12 example: 12
auth_events: auth_events:
type: array type: array
description: Event IDs and hashes for the "auth events" of this event description: Event IDs and hashes for the "auth events" of this event.
items: items:
type: array type: array
maxItems: 2 maxItems: 2
@ -96,16 +96,16 @@ properties:
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: For redaction events, the ID of the event being redacted description: For redaction events, the ID of the event being redacted.
example: "$def456:matrix.org" example: "$def456:matrix.org"
unsigned: unsigned:
type: object type: object
description: Additional data added by the origin server but not covered by the ``signatures`` description: Additional data added by the origin server but not covered by the ``signatures``.
example: {"key": "value"} example: {"key": "value"}
required: required:
- room_id - room_id

@ -33,37 +33,37 @@ paths:
- in: path - in: path
name: roomId name: roomId
type: string type: string
description: The room ID to get state for description: The room ID to get state for.
required: true required: true
x-example: "!abc123:matrix.org" x-example: "!abc123:matrix.org"
responses: responses:
200: 200:
description: The room state for the room (kept under ``pdus``) description: The room state for the room (kept under ``pdus``).
schema: schema:
$ref: "definitions/transaction.yaml" $ref: "definitions/transaction.yaml"
"/event/{eventId}": "/event/{eventId}":
get: get:
summary: Get a single event summary: Get a single event
description: |- description: |-
Retrieves a single event Retrieves a single event.
operationId: getEvent operationId: getEvent
parameters: parameters:
- in: path - in: path
name: eventId name: eventId
type: string type: string
description: The event ID to get description: The event ID to get.
required: true required: true
x-example: "$abc123:matrix.org" x-example: "$abc123:matrix.org"
responses: responses:
200: 200:
description: A transaction containing a single PDU which is the event requested description: A transaction containing a single PDU which is the event requested.
schema: schema:
$ref: "definitions/transaction.yaml" $ref: "definitions/transaction.yaml"
"/backfill/{roomId}": "/backfill/{roomId}":
get: get:
summary: Retrieves the events which precede the given event summary: Retrieves the events which precede the given event
description: |- description: |-
Retreives a sliding-window history of previous PDUs that occurred on the given room. Retreives a sliding-window history of previous PDUs that occurred in the given room.
Starting from the PDU ID(s) given in the ``v`` argument, the PDUs that preceded it Starting from the PDU ID(s) given in the ``v`` argument, the PDUs that preceded it
are retrived, up to the total number given by the ``limit``. are retrived, up to the total number given by the ``limit``.
operationId: backfillRoom operationId: backfillRoom
@ -71,19 +71,19 @@ paths:
- in: path - in: path
name: roomId name: roomId
type: string type: string
description: The room ID to backfill description: The room ID to backfill.
required: true required: true
x-example: "!abc123:matrix.org" x-example: "!abc123:matrix.org"
- in: query - in: query
name: v name: v
type: string # TODO: The description says this is plural - figure out how to specify multiple, and spec it type: string # TODO: The description says this is plural - figure out how to specify multiple, and spec it
description: The event ID to backfill from description: The event ID to backfill from.
required: true required: true
x-example: "$abc123:matrix.org" x-example: "$abc123:matrix.org"
- in: query - in: query
name: limit name: limit
type: integer type: integer
description: The maximum number of events to retrieve description: The maximum number of events to retrieve.
required: true # TODO: Verify required: true # TODO: Verify
x-example: 10 x-example: 10
responses: responses:
@ -91,6 +91,7 @@ paths:
description: A transaction containing the PDUs that preceded the given event(s). description: A transaction containing the PDUs that preceded the given event(s).
schema: schema:
$ref: "definitions/transaction.yaml" $ref: "definitions/transaction.yaml"
# TODO: It's possible that this endpoint doesn't exist anymore - verify
"/pull": "/pull":
get: get:
summary: Stream events later than a given point in history summary: Stream events later than a given point in history
@ -101,7 +102,7 @@ paths:
- in: query - in: query
name: v name: v
type: string # TODO: The description says this is plural - figure out how to specify multiple, and spec it type: string # TODO: The description says this is plural - figure out how to specify multiple, and spec it
description: The event ID to backfill from description: The event ID to backfill from.
required: true required: true
x-example: "$abc123:matrix.org" x-example: "$abc123:matrix.org"
- in: query - in: query

Loading…
Cancel
Save