Commit Graph

1166 Commits (29f23a5edaa0920b9a9f4a538ed7a4ab6e2a167a)

Author SHA1 Message Date
Travis Ralston 29f23a5eda
Merge pull request #2599 from matrix-org/travis/typos
Fix typos and clarify the user ID in login sections
5 years ago
Hubert Chathi cf37688b7c
Merge pull request #2387 from uhoreg/key_backup_spec
initial version of spec for key backups
5 years ago
Hubert Chathi a36284810d more clarifications and fixes 5 years ago
Travis Ralston d9a1de1d30 Fix typos and clarify the user ID in login sections 5 years ago
Hubert Chathi 40c50c80ea
Apply suggestions from code review
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
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
Hubert Chathi fae1165e1c spec what to do if you try to delete a backup that's already deleted 5 years ago
Hubert Chathi bd95568c8c remove duplicate key 5 years ago
Hubert Chathi 1bae8ea633 we actually don't support the GET /room_key/versions/ with trailing slash 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
Hubert Chathi a896729ac2 some more clarifications and indentation fixes 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 0145191d43 add links to endpoints and add delete endpoint 5 years ago
Hubert Chathi 5f3ee44cfb add more suggestions from review 5 years ago
Hubert Chathi 8ff1c26ef2 fix indentation 5 years ago
Hubert Chathi e0b4a3c912
Apply suggestions from code review
Co-authored-by: Travis Ralston <travpc@gmail.com>
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