3d954f93b5
Clarify that the room ID is the object key in /sync responses
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
2019-11-04 15:57:58 -07:00
19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
...
Spec lazy-loading room members
2019-06-11 09:39:32 -06:00
c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs
...
Clarify how notification counts are calculated in /sync
2019-06-11 07:50:33 -06:00
1886a2346a
Move explanation of notifications to notifications module
2019-06-10 13:38:43 -06:00
0506d09cf7
incorporate LL review from matthew
2019-06-10 19:38:44 +01:00
a38af2009f
Apply suggestions from code review
...
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-06-07 10:37:57 -06:00
77c4c4b07c
Add general clarity
2019-06-07 08:27:18 -06:00
f0eb495cee
Clarify how notification counts are calculated in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
2019-06-06 15:41:28 -06:00
afead2eb1b
Clarify LL in /sync a bit more
2019-06-06 14:18:41 -06:00
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.
2019-06-02 17:41:39 -06:00
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.
2019-05-29 15:28:48 -06:00
c25afa663e
Use consistent event examples throughout the Client-Server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
2019-05-29 14:57:56 -06:00
c5fdd5cb0b
Change note style
2019-05-28 13:57:08 -06:00
551806a8ad
Add a reference to the filtering module to /sync
2019-05-28 13:57:08 -06:00
b3d86f99b9
Add room summary spec
2019-05-27 20:20:00 -06:00
ba520df004
Move lazy loading to a section in Filtering
2019-05-27 17:38:11 -06:00
b67161cf97
List the endpoints which are lazy-loading aware
2019-05-27 17:38:11 -06:00
8c80669d7a
Add the paragraph for sync.yaml forgotten in the previous commit
2018-12-23 18:58:44 +09:00
e3ad253dca
A sender is also required for the invite_state
2018-08-31 09:44:29 -06:00
2f824df8dd
Define the real event types on the invite_state
2018-08-31 09:43:29 -06:00
2e3e189ea2
Merge remote matrix-org/master
2018-08-31 09:31:39 -06:00
436544b8f8
Clarify behaviour of `?set_presence=unavailable` for /sync
2018-08-28 14:19:55 -06:00
adef7babfa
Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields
2018-08-28 14:10:17 -06:00
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
2018-08-26 22:22:36 -06:00
008ebb8c1a
Add `account_data` to left rooms in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
2018-08-26 21:55:30 -06:00
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
2018-08-18 11:41:45 +02:00
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
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
1e3f5683c8
Make clear that the /sync timeout is zero by default
2017-08-31 16:56:50 +01:00
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
2017-04-20 16:51:42 +01:00
09a768763d
Add missing enum fields for the set_presence parameter
...
Signed-off-by: Konstantinos Sideris <siderisk@auth.gr>
2017-01-14 19:10:35 +02:00
ebaaa7e3b3
Review feedback
...
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
2016-09-29 13:18:45 +01:00
ccd7bb32d5
Specification for direct-to-device messages
2016-09-27 14:27:27 +01:00
7478e7f3cf
Add top-level account_data to /sync response
2016-08-30 17:43:20 +01:00
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
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
2016-05-03 13:57:16 +01:00
a78dff3981
Add notification counts to doc
2016-03-01 11:40:52 +00:00
cfbb695fd3
typoe
2016-01-13 18:25:33 +00:00
c3a1318886
Make it explicit that the JSON filter object is passed as a string
2015-12-09 10:50:02 +00:00
ed70bcb180
Add a rationale for allowing both inline filters and passing filters by id.
2015-12-08 14:36:50 +00:00
878ce2f206
Allow the filter JSON to be passed inline in the /sync request
2015-12-08 14:32:11 +00:00
f81b967e2d
Make all the schema files yaml
2015-12-07 13:56:36 +00:00
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
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
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
Travis Ralston