Commit Graph

22 Commits (b8dafe86f4d9bf9f81cb623f697381f62ff8a267)

Author SHA1 Message Date
Kitsune Ral 040a91f42d api/: More cleanup in descriptions
(and a fix in one example).
5 years ago
Neil Johnson bf2b6e6daa remove references to presence lists 6 years ago
Travis Ralston 84e07a0c10 Convert errors in presence.yaml 6 years ago
Travis Ralston 8b513b9f8e Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 6 years ago
Travis Ralston 05c85fd840 Spec the 403 on GET /presence/{userId}/status 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
Travis Ralston 1f12637d3f Getting presence requires authentication 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 4f37e4ece0 Merge pull request #342 from matrix-org/erikj/presence
Fix and correctly document presence's currently_active
9 years ago
Erik Johnston 0de8ba7f0a currently_active is a param on GET response, not put 9 years ago
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
9 years ago
Erik Johnston 2691d4925b s/currently_online/currently_active/ 9 years ago
Richard van der Hoff 5383754a40 Access event-schemas via a symlink
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
9 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
9 years ago
Erik Johnston cbe466e572 Update API docs 9 years ago
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 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 aa4ed10821 Unify v1 and v2 event schemas 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