Travis Ralston
db72e7caea
Merge pull request #2575 from matrix-org/travis/clarification/send-join
...
Clarify the auth_chain and state requirements for /send_join
5 years ago
Travis Ralston
c3289614da
Merge pull request #2562 from matrix-org/travis/spec/2432-alias-semantics
...
Add spec for new alias handling (client-server)
5 years ago
Travis Ralston
04a26dafd0
Merge pull request #2546 from matrix-org/travis/spec/1466-softlogout
...
Spec soft-logout per MSC1466
5 years ago
Travis Ralston
a5cb9c655c
It's important to say who
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
Travis Ralston
bea6b321a5
Change the nots order
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
Travis Ralston
9bdafab2a4
Merge pull request #2571 from matrix-org/travis/clarification/createRoom-events
...
Clarify that a creation event and member event are needed for createRoom
5 years ago
Travis Ralston
669377888e
Fix more typos throughout the specification
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2193
5 years ago
Travis Ralston
67d46fa881
Clarify the auth_chain and state for send_join
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2467
Fixes https://github.com/matrix-org/matrix-doc/issues/2464
This is based on looking at Synapse, not actually testing it. Within the send_join handling functions, an "event context" is acquired [here](d14c4d6b6d/synapse/handlers/federation.py (L1472)
) which then later uses the previous state (populated [here](d14c4d6b6d/synapse/state/__init__.py (L286-L289)
) in the event context) [here](d14c4d6b6d/synapse/handlers/federation.py (L1494-L1501)
) to return a response. Within the event context, the previous state IDs are populated [here](d14c4d6b6d/synapse/state/__init__.py (L351)
).
5 years ago
Travis Ralston
06b0c1762a
Move the send_join response to its own definition
...
Both APIs need clarification, so dedupe the changes.
We should also probably deprecate some of this stuff so we can eventually remove it.
5 years ago
Travis Ralston
200212ffd7
Clarify that a creation event and member event are needed for createRoom
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2494
5 years ago
Travis Ralston
36ed6e94a2
Re-introduce signature schemas
5 years ago
Hubert Chathi
6a8ba9b1d6
improve description of key object in CS and include a link in Fed
5 years ago
Hubert Chathi
5b38c04e19
make definition of signatures fields more consistent
5 years ago
Travis Ralston
12ecf9f383
Merge pull request #2561 from matrix-org/travis/doc-2xx-format
...
Mention that we use OpenAPI 3's response code format
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
1388742a52
Mention that we use OpenAPI 3's response code format
...
See comments of https://github.com/matrix-org/matrix-doc/pull/2238
5 years ago
Travis Ralston
74b627ac0b
Fix the response format of the `/send` endpoint
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
5 years ago
Kegsay
fc91946e5a
Update api/server-server/backfill.yaml
...
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
Kegan Dougal
9765116c47
Make backfill wording clearer
5 years ago
Travis Ralston
05e83f2e7d
Fix more describes -> describe
5 years ago
Travis Ralston
0e771c7b07
Merge pull request #2547 from matrix-org/travis/spec/1802-fix-200
...
Spec v2 send_join and send_leave endpoints
5 years ago
Travis Ralston
7c0046ffc7
describes -> describe
5 years ago
Travis Ralston
d419e3b38a
Remove extraneous spaces
5 years ago
Dominic Fischer
28d460fb62
Fix Typo
5 years ago
Travis Ralston
a2a1694c35
Spec v2 send_join and send_leave endpoints
...
MSC: https://github.com/matrix-org/matrix-doc/pull/1802
Fixes https://github.com/matrix-org/matrix-doc/issues/2541
This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
5 years ago
Travis Ralston
d24f15a3a9
Spec soft-logout per MSC1466
...
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
5 years ago
Travis Ralston
42ae5c966a
Clarify the limits of prev_events and auth_events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2307
These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.
Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)
... and Synapse's handling of the backfill endpoint is described here: 207b1737ee/synapse/handlers/federation.py (L829-L837)
This also includes a mention that https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary.
No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
5 years ago
Gnuxie
6b8b31ce63
correct use of required annotation in json-schema
...
https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3
5 years ago
Hubert Chathi
0d2924841b
Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005
...
misc fixes in e2ee spec
5 years ago
Damir Jelić
6e33954256
client-server: Mark the event_id when putting room events as required.
5 years ago
Hubert Chathi
e89521d195
some fixes (spelling, RST, and naming)
5 years ago
Patrick Cloke
1e330c9423
Clarify revocation behavior.
5 years ago
Patrick Cloke
0c582ea8c7
Apply suggestions from code review
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
Patrick Cloke
958e1b4a2e
Make the spec changes for MSC 2457.
5 years ago
Patrick Cloke
fc03f7faa6
Remove query_auth from the specification per MSC2451.
5 years ago
Aaron Axvig
4d808762da
Change formatting from italics to code
5 years ago
Örjan Fors
e151ba96ac
Fix typo for upgrade
...
Signed-off-by: Örjan Fors <orion@29k.org>
5 years ago
Isaiah Inuwa
8e888b916c
Fix spelling mistakes.
5 years ago
Travis Ralston
f59aa563dd
Add missing tags to push rules endpoints
...
Without the tags, the endpoints don't end up in the swagger. No changelog for this because it doesn't affect the spec itself.
5 years ago
Stuart Mumford
c2ffef051f
Clarify description of user directory
...
Signed off by Stuart Mumford <stuart@cadair.com>
5 years ago
Travis Ralston
14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338
...
Add filter query param to /context
5 years ago
Travis Ralston
9f01850f7a
Add some words about where the filter is applied
5 years ago
Travis Ralston
a1e5a96cf8
Update api/client-server/event_context.yaml
...
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
Travis Ralston
8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120
...
Recommend that clients don't preview URLs in encrypted rooms
5 years ago
Travis Ralston
e59bb20dc3
Try to clarify the filter information on /context
5 years ago
Travis Ralston
ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298
...
Clarify that submit_url is without authentication
5 years ago
Travis Ralston
f012da17a1
Explain why e2e previews are bad
5 years ago
Travis Ralston
a50e828509
Merge pull request #2342 from matrix-org/travis/spec/fix-1982
...
Clarify what format the `country` is on phone number inputs
5 years ago
Travis Ralston
3d954f93b5
Clarify that the room ID is the object key in /sync responses
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
5 years ago
Travis Ralston
021c056efc
Add filter query param to /context
...
This was missed as part of lazy-loading.
Fixes https://github.com/matrix-org/matrix-doc/issues/2338
5 years ago