Commit Graph

17 Commits (f0ba7f014b1dc21baaff999e0bd710fa13baf731)

Author SHA1 Message Date
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
Damir Jelić 6e33954256 client-server: Mark the event_id when putting room events as required. 5 years ago
Travis Ralston 370ae8b9fe
Merge pull request #2068 from matrix-org/travis/1.0/mxc
Refactor documentation for content/media repository
6 years ago
Travis Ralston c8a3850598 Merge GET/PUT /state/:event_type endpoints
Clarifying that the state key is optional, and how that works.

Fixes https://github.com/matrix-org/matrix-doc/issues/1182
6 years ago
Travis Ralston 1f86e8e31b Refactor documentation for content/media repository
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
6 years ago
Travis Ralston d91395cf9f Document 403 error for sending state events
Fixes https://github.com/matrix-org/matrix-doc/issues/1399
6 years ago
Konstantinos Sideris 7448ef0db0 Use the correct event_id format on examples
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
7 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 750d980bc0 Room member (#950)
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
7 years ago
Matthew Hodgson 978d9ea6dd fix the descriptions of the /room/.../state APIs to not be the wrong way round 8 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
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 e0ebabf8cc Explicitly document /rooms/{roomId}/state/{eventType} without state key 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