Skip to content

Specify that application services receive events in the CSAPI format #1552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 28, 2018
Merged

Specify that application services receive events in the CSAPI format #1552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbd33c1
Move appservice transaction API to the right section
turt2live Aug 23, 2018
6a91ea9
Specify that application services receive events in the CSAPI format
turt2live Aug 23, 2018
51193ca
Merge remote-tracking branch 'matrix-org/master' into travis/as/norma…
turt2live Aug 27, 2018
17e0ef4
Remove empty file and now-empty section from the appservice spec
turt2live Aug 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 6 additions & 30 deletions ...lication-service/application_service.yaml → api/application-service/transactions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ schemes:
- https
- http
basePath: "/"
consumes:
- application/json
produces:
- application/json
paths:
Expand Down Expand Up @@ -53,37 +51,16 @@ paths:
type: object
example: {
"events": [
{
"age": 32,
"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"
}
{"$ref": "../../event-schemas/examples/m.room.member"},
{"$ref": "../../event-schemas/examples/m.room.message#m.text"}
]
}
description: "Transaction informations"
description: Transaction information
properties:
events:
type: array
description: A list of events
description: |-
A list of events, formatted as per the Client-Server API.
items:
type: object
title: Event
Expand All @@ -92,7 +69,6 @@ paths:
200:
description: The transaction was processed successfully.
examples:
application/json: {
}
application/json: {}
schema:
type: object
11 changes: 2 additions & 9 deletions specification/application_service_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
on retries, as the AS may have already processed the events.

{{transactions_as_http_api}}

Querying
++++++++

Expand Down Expand Up @@ -244,15 +246,6 @@ application service for filtering.
{{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`_

Client-Server API Extensions
Expand Down