36b02edfc2
Fixes #3305 Fixes #3380 The idea here is to better distinguish between a 'raw' event (as we send over the wire), and the 'serialised' format, as sent in responses to the C-S api and in `PUT /_matrix/app/v1/transactions/{txnId}`. It's made more complicated by the fact that there are _two_ serialisation formats, one used by `/sync` and `/notifications`, and one by everything else (the difference being whether `room_id` is included). In an ideal world, we wouldn't repeat `SerialisedEvent` every time it's used, and instead just link to the first reference, but that's a job for another day. Another job for another day is to get rid of things like `sync_state_event.yaml` (which is now used only in one place, so should be inlined.)
134 lines
4.8 KiB
YAML
134 lines
4.8 KiB
YAML
# Copyright 2016 OpenMarket 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 Client-Server Notifications API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/client/v3
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
$ref: definitions/security.yaml
|
|
paths:
|
|
"/notifications":
|
|
get:
|
|
summary: Gets a list of events that the user has been notified about
|
|
description: |-
|
|
This API is used to paginate through the list of events that the
|
|
user has been, or would have been notified about.
|
|
operationId: getNotifications
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: query
|
|
type: string
|
|
name: from
|
|
description: |-
|
|
Pagination token to continue from. This should be the `next_token`
|
|
returned from an earlier call to this endpoint.
|
|
required: false
|
|
x-example: "xxxxx"
|
|
- in: query
|
|
type: integer
|
|
name: limit
|
|
description: Limit on the number of events to return in this request.
|
|
required: false
|
|
x-example: 20
|
|
- in: query
|
|
name: only
|
|
type: string
|
|
description: |-
|
|
Allows basic filtering of events returned. Supply `highlight`
|
|
to return only events where the notification had the highlight
|
|
tweak set.
|
|
required: false
|
|
x-example: "highlight"
|
|
responses:
|
|
200:
|
|
description: A batch of events is being returned
|
|
examples:
|
|
application/json: {
|
|
"next_token": "abcdef",
|
|
"notifications": [
|
|
{
|
|
"actions": [
|
|
"notify"
|
|
],
|
|
"profile_tag": "hcbvkzxhcvb",
|
|
"read": true,
|
|
"room_id": "!abcdefg:example.com",
|
|
"ts": 1475508881945,
|
|
"event": {
|
|
"$ref": "../../event-schemas/examples/m.room.message$m.text.yaml"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
schema:
|
|
type: object
|
|
required: ["notifications"]
|
|
properties:
|
|
next_token:
|
|
type: string
|
|
description: |-
|
|
The token to supply in the `from` param of the next
|
|
`/notifications` request in order to request more
|
|
events. If this is absent, there are no more results.
|
|
notifications:
|
|
type: array
|
|
items:
|
|
type: object
|
|
required: ["actions", "event", "read", "room_id", "ts"]
|
|
title: Notification
|
|
properties:
|
|
actions:
|
|
type: array
|
|
description: |-
|
|
The action(s) to perform when the conditions for this rule are met.
|
|
See [Push Rules: API](/client-server-api/#push-rules-api).
|
|
items:
|
|
type:
|
|
- object
|
|
- string
|
|
event:
|
|
type: object
|
|
title: Event
|
|
description: The Event object for the event that triggered the notification.
|
|
"$ref": "definitions/client_event_without_room_id.yaml"
|
|
profile_tag:
|
|
type: string
|
|
description: The profile tag of the rule that matched this event.
|
|
read:
|
|
type: boolean
|
|
description: |-
|
|
Indicates whether the user has sent a read receipt indicating
|
|
that they have read this message.
|
|
room_id:
|
|
type: string
|
|
description: The ID of the room in which the event was posted.
|
|
ts:
|
|
type: integer
|
|
description: |-
|
|
The unix timestamp at which the event notification was sent,
|
|
in milliseconds.
|
|
description: The list of events that triggered notifications.
|
|
tags:
|
|
- Push notifications
|