Commit Graph

14 Commits (6c6bd57ebfd6a52ede63b611a52d3a801888da04)

Author SHA1 Message Date
Travis Ralston bea6b321a5
Change the nots order
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
Travis Ralston b11cf560b5 Add spec for new alias handling (client-server)
MSC: https://github.com/matrix-org/matrix-doc/pull/2432

This commit does not deal with areas which will be covered by the room version specifications (namely the redaction algorithm).

It feels a bit overly cruel to completely obliterate all mentions of `m.room.aliases` from the spec as client/server developers may encounter the event type in the wild. To ensure that CTRL+F still works, a brief mention that they do nothing has been put in place, leaving no other references (except the redaction algorithm - see previous paragraph).
5 years ago
Travis Ralston d52fcdacfa Add M_NOT_FOUND definition for deleting non-existent aliases
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
6 years ago
Travis Ralston e60b44e27f Clean up PUT /directory/room
Fixes https://github.com/matrix-org/matrix-doc/issues/933

The issue references two problems: a `roomInfo` and lack of a `room_id`. It appears the `room_id` has been fixed since reporting, however the `roomInfo` remained (and is now fixed).
6 years ago
Travis Ralston caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
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
Brendan Abolivier fee65dbacb
Fix response format and 404 example for room alias lookup 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 7bbb664784 Improve documentation of directory API 9 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
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 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