Travis Ralston
caa6d4d9ad
Give all errors a schema reference
...
This just helps keep an overall structure
2018-07-04 13:54:52 -06:00
Travis Ralston
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
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>
2017-10-11 01:58:31 +09:00
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.
2017-09-27 08:04:24 +01:00
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).
2016-07-12 17:28:30 +01:00
Richard van der Hoff
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
2016-05-03 13:57:16 +01:00
David Baker
1a856b53f3
Remove redundant info & add backticks
2016-04-13 10:29:57 +01:00
David Baker
4b294b23de
Tailor descriptions to GET method
2016-04-12 09:56:24 +01:00
David Baker
4fafe1ab73
Return an object as the root element
...
Because otherwise it's impossible to change later
2016-04-11 17:56:38 +01:00
David Baker
42834340e7
Add title to the pushers array
2016-04-11 17:41:15 +01:00
David Baker
0f6e414eb6
Fix format (array of objects, not object)
2016-04-11 17:35:56 +01:00
David Baker
27113d71ff
Fix indentation
2016-04-11 17:31:42 +01:00
David Baker
73d6e901ae
Add endpoint for getting a user's pushers
...
Also add profile_tag to the set docs as it was missing
2016-04-11 17:25:36 +01:00
Daniel Wagner-Hall
11c572267e
Add titles where they're missing
2016-03-02 15:23:48 +00:00
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.
2016-02-18 16:05:47 +00:00
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.
2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall
2f3a00fe34
Consistently spell homeserver as homeserver
2015-12-02 19:23:33 +00:00
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.
2015-11-30 11:22:57 +00:00
