Commit Graph

13 Commits (a5e3652d26ccf97ca321370fd2c020ed36855617)

Author SHA1 Message Date
reivilibre 8033ab1c86 Fix Push Gateway API example: Field renamed to event_id
I believe this was forgotten in:
71cb646541
5 years ago
Travis Ralston de961fb7d6 Improve wording on push gateways 6 years ago
Travis Ralston 6ad71f785e Improve documentation for pushers and push gateways
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format

Note: this does not attempt to document push rules, just pushers.

Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
6 years ago
Kitsune Ral 24afe7987c Add operationId to all endpoints of all APIs
To facilitate generation of API stubs from the spec.

Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
Richard van der Hoff 820704a16a Format examples as raw objects
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).

The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
7 years ago
Richard van der Hoff 49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
8 years ago
David Baker cf850b4270 Fix level of `counts` and `devices`
They are actually within the notification object rather than the top level object. Add titles to objects so it works.
9 years ago
David Baker 89453bfd8c Remove spurious blank line 9 years ago
David Baker 64c6d30f90 hopefully fix rst 9 years ago
David Baker 7faf2cf642 Paragraph breaks & missed word 9 years ago
David Baker 7e1cb9003c Make swagger valid 9 years ago
David Baker 71cb646541 Change `id` in the push gateway poke to be `event_id` and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 9 years ago
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 9 years ago