Commit Graph

44 Commits (d09af5b191472fd7078aeff1b5c13558ab4a1212)

Author SHA1 Message Date
Travis Ralston 19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
Spec lazy-loading room members
5 years ago
Travis Ralston c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs
Clarify how notification counts are calculated in /sync
5 years ago
Travis Ralston 1886a2346a Move explanation of notifications to notifications module 5 years ago
Matthew Hodgson 0506d09cf7 incorporate LL review from matthew 5 years ago
Travis Ralston a38af2009f
Apply suggestions from code review
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
Travis Ralston 77c4c4b07c Add general clarity 5 years ago
Travis Ralston f0eb495cee Clarify how notification counts are calculated in /sync
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
5 years ago
Travis Ralston afead2eb1b Clarify LL in /sync a bit more 5 years ago
Travis Ralston 7a07a6b358 Clarify exactly what StrippedState is
Fixes https://github.com/matrix-org/matrix-doc/issues/2066

The expectation everywhere is that the `sender` is required. `/initialSync` references StrippedState through a `m.room.member` event reference, and does not need editing.
5 years ago
Travis Ralston d6d74c4cbe Switch to using $ instead of # for sub-types
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.

Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
5 years ago
Travis Ralston c25afa663e Use consistent event examples throughout the Client-Server API
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
5 years ago
Travis Ralston c5fdd5cb0b Change note style 5 years ago
Travis Ralston 551806a8ad Add a reference to the filtering module to /sync 5 years ago
Travis Ralston b3d86f99b9 Add room summary spec 5 years ago
Travis Ralston ba520df004 Move lazy loading to a section in Filtering 5 years ago
Travis Ralston b67161cf97 List the endpoints which are lazy-loading aware 5 years ago
Kitsune Ral 8c80669d7a Add the paragraph for sync.yaml forgotten in the previous commit 6 years ago
Travis Ralston e3ad253dca A sender is also required for the invite_state 6 years ago
Travis Ralston 2f824df8dd Define the real event types on the invite_state 6 years ago
Travis Ralston 2e3e189ea2 Merge remote matrix-org/master 6 years ago
Travis Ralston 436544b8f8 Clarify behaviour of `?set_presence=unavailable` for /sync 6 years ago
Travis Ralston adef7babfa Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields 6 years ago
Travis Ralston 55c0b968b5 Fix event schemas for /sync
This commit clarifies the required keys for each type of event that appears in sync, fixes the core event schema not declaring 'content' as required, and includes a mention that events may not have a room_id when appearing in /sync.

Fixes https://github.com/matrix-org/matrix-doc/issues/595
Fixes https://github.com/matrix-org/matrix-doc/issues/909
6 years ago
Travis Ralston 008ebb8c1a Add `account_data` to left rooms in /sync
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
6 years ago
Valentin Deniaud 10c3307427 document device_one_time_keys_count in /sync/ response
fix #1157
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 1e3f5683c8 Make clear that the /sync timeout is zero by default 7 years ago
Richard van der Hoff da6938b818 Key management APIs (#894)
Spec the e2e key-management APIs.
7 years ago
Konstantinos Sideris 09a768763d Add missing enum fields for the set_presence parameter
Signed-off-by: Konstantinos Sideris <siderisk@auth.gr>
8 years ago
Richard van der Hoff ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 8 years ago
Richard van der Hoff 7478e7f3cf Add top-level account_data to /sync response 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
8 years ago
David Baker a78dff3981 Add notification counts to doc 8 years ago
Matthew Hodgson cfbb695fd3 typoe 9 years ago
Mark Haines c3a1318886 Make it explicit that the JSON filter object is passed as a string 9 years ago
Mark Haines ed70bcb180 Add a rationale for allowing both inline filters and passing filters by id. 9 years ago
Mark Haines 878ce2f206 Allow the filter JSON to be passed inline in the /sync request 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 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