Move appservice transaction API to the right section
Part of https://github.com/matrix-org/matrix-doc/issues/1532
This commit is contained in:
parent
6172d5986a
commit
bbd33c1461
3 changed files with 100 additions and 70 deletions
|
@ -26,76 +26,6 @@ consumes:
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
paths:
|
paths:
|
||||||
"/transactions/{txnId}":
|
|
||||||
put:
|
|
||||||
summary: Send some events to the application service.
|
|
||||||
description: |-
|
|
||||||
This API is called by the homeserver when it wants to push an event
|
|
||||||
(or batch of events) to the application service.
|
|
||||||
|
|
||||||
Note that the application service should distinguish state events
|
|
||||||
from message events via the presence of a ``state_key``, rather than
|
|
||||||
via the event type.
|
|
||||||
operationId: sendTransaction
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: txnId
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
The transaction ID for this set of events. Homeservers generate
|
|
||||||
these IDs and they are used to ensure idempotency of requests.
|
|
||||||
required: true
|
|
||||||
x-example: "35"
|
|
||||||
- in: body
|
|
||||||
name: body
|
|
||||||
description: A list of events.
|
|
||||||
schema:
|
|
||||||
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"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
description: "Transaction informations"
|
|
||||||
properties:
|
|
||||||
events:
|
|
||||||
type: array
|
|
||||||
description: A list of events
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
title: Event
|
|
||||||
required: ["events"]
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: The transaction was processed successfully.
|
|
||||||
examples:
|
|
||||||
application/json: {
|
|
||||||
}
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
"/_matrix/app/unstable/thirdparty/protocol/{protocol}":
|
"/_matrix/app/unstable/thirdparty/protocol/{protocol}":
|
||||||
get:
|
get:
|
||||||
summary: Retrieve metadata about a specific protocol that the application service supports.
|
summary: Retrieve metadata about a specific protocol that the application service supports.
|
||||||
|
|
98
api/application-service/transactions.yaml
Normal file
98
api/application-service/transactions.yaml
Normal file
|
@ -0,0 +1,98 @@
|
||||||
|
# Copyright 2016 OpenMarket Ltd
|
||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Application Service API"
|
||||||
|
version: "1.0.0"
|
||||||
|
host: localhost:8008
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
- http
|
||||||
|
basePath: "/"
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
paths:
|
||||||
|
"/transactions/{txnId}":
|
||||||
|
put:
|
||||||
|
summary: Send some events to the application service.
|
||||||
|
description: |-
|
||||||
|
This API is called by the homeserver when it wants to push an event
|
||||||
|
(or batch of events) to the application service.
|
||||||
|
|
||||||
|
Note that the application service should distinguish state events
|
||||||
|
from message events via the presence of a ``state_key``, rather than
|
||||||
|
via the event type.
|
||||||
|
operationId: sendTransaction
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: txnId
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The transaction ID for this set of events. Homeservers generate
|
||||||
|
these IDs and they are used to ensure idempotency of requests.
|
||||||
|
required: true
|
||||||
|
x-example: "35"
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
description: A list of events.
|
||||||
|
schema:
|
||||||
|
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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
description: "Transaction informations"
|
||||||
|
properties:
|
||||||
|
events:
|
||||||
|
type: array
|
||||||
|
description: A list of events
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: Event
|
||||||
|
required: ["events"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The transaction was processed successfully.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
|
@ -155,6 +155,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
|
||||||
++++++++
|
++++++++
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue