Commit Graph

23 Commits (d7263861d84415fd4ac3e0e0fb01c30c05af2244)

Author SHA1 Message Date
Travis Ralston 5b30d33b89
Simpler language 6 years ago
Travis Ralston c891e4a957 Require the push gateway URL to be of a specific path 6 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
Travis Ralston caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
6 years ago
Travis Ralston 7cd22f5690 Describe the rate limit error everywhere
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
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
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
9 years ago
David Baker 1a856b53f3 Remove redundant info & add backticks 9 years ago
David Baker 4b294b23de Tailor descriptions to GET method 9 years ago
David Baker 4fafe1ab73 Return an object as the root element
Because otherwise it's impossible to change later
9 years ago
David Baker 42834340e7 Add title to the pushers array 9 years ago
David Baker 0f6e414eb6 Fix format (array of objects, not object) 9 years ago
David Baker 27113d71ff Fix indentation 9 years ago
David Baker 73d6e901ae Add endpoint for getting a user's pushers
Also add profile_tag to the set docs as it was missing
9 years ago
Daniel Wagner-Hall 11c572267e Add titles where they're missing 9 years ago
Mark Haines 3db6980e0b Remove references to device specific push rules
Since they weren't implemented on the servers and weren't
used by the clients.
9 years ago
Daniel Wagner-Hall 1f5b6271f2 Generate swagger-ui output for client-server API
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
9 years ago
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 9 years ago
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 9 years ago
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago