Merge pull request #1552 from turt2live/travis/as/normal-events

Specify that application services receive events in the CSAPI format
This commit is contained in:
Travis Ralston 2018-08-27 18:00:25 -06:00 committed by GitHub
commit bba76c23d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 39 deletions

View file

@ -21,8 +21,6 @@ schemes:
- https - https
- http - http
basePath: "/" basePath: "/"
consumes:
- application/json
produces: produces:
- application/json - application/json
paths: paths:
@ -53,37 +51,16 @@ paths:
type: object type: object
example: { example: {
"events": [ "events": [
{ {"$ref": "../../event-schemas/examples/m.room.member"},
"age": 32, {"$ref": "../../event-schemas/examples/m.room.message#m.text"}
"content": {
"body": "incoming message",
"msgtype": "m.text"
},
"event_id": "$14328055551tzaee:localhost",
"origin_server_ts": 1432804485886,
"room_id": "!TmaZBKYIFrIPVGoUYp:localhost",
"type": "m.room.message",
"user_id": "@bob:localhost"
},
{
"age": 1984,
"content": {
"body": "another incoming message",
"msgtype": "m.text"
},
"event_id": "$1228055551ffsef:localhost",
"origin_server_ts": 1432804485886,
"room_id": "!TmaZBKYIFrIPVGoUYp:localhost",
"type": "m.room.message",
"user_id": "@bob:localhost"
}
] ]
} }
description: "Transaction informations" description: Transaction information
properties: properties:
events: events:
type: array type: array
description: A list of events description: |-
A list of events, formatted as per the Client-Server API.
items: items:
type: object type: object
title: Event title: Event
@ -92,7 +69,6 @@ paths:
200: 200:
description: The transaction was processed successfully. description: The transaction was processed successfully.
examples: examples:
application/json: { application/json: {}
}
schema: schema:
type: object type: object

View file

@ -198,6 +198,8 @@ be made without blocking other aspects of the homeserver. Homeservers MUST NOT
alter (e.g. add more) events they were going to send within that transaction ID alter (e.g. add more) events they were going to send within that transaction ID
on retries, as the AS may have already processed the events. on retries, as the AS may have already processed the events.
{{transactions_as_http_api}}
Querying Querying
++++++++ ++++++++
@ -244,15 +246,6 @@ application service for filtering.
{{protocols_as_http_api}} {{protocols_as_http_api}}
HTTP APIs
+++++++++
This contains application service APIs which are used by the homeserver. All
application services MUST implement these APIs. These APIs are defined below.
{{application_service_as_http_api}}
.. _create the user: `sect:asapi-permissions`_ .. _create the user: `sect:asapi-permissions`_
Client-Server API Extensions Client-Server API Extensions