Commit Graph

1180 Commits (adc867dc9957f994633a01312b71f8cd6f842950)

Author SHA1 Message Date
Olivier Wilkinson (reivilibre) 2e72da2343 Fix spec bug concerning the type of a push rule's array of actions
Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
4 years ago
Aaron Raimist f8ff2ad6a9
Reword "UI Authorization" to "User-Interactive Authentication" (#2667)
Signed-off-by: Aaron Raimist <aaron@raim.ist>
4 years ago
Hubert Chathi a91c6446bc
Merge pull request #2639 from uhoreg/backup_version_required
various key backups fixes
4 years ago
Travis Ralston 465ed38416
Merge pull request #2647 from jplatte/event-titles
Make event's title fields UpperCamelCase and distinguish /sync ones
4 years ago
Jonas Platte 763e5654cc
Make event's title fields UpperCamelCase and distinguish /sync ones 4 years ago
Jonas Platte 049275c33b
Consistently use the title UnsignedData for the unsigned object 4 years ago
Hubert Chathi 24427242f7 fix more mistakes in key backup spec, and factor out room key backups 4 years ago
Hubert Chathi af6e1157d9 version is required when getting keys. Also add some full stops. 4 years ago
Nicolas Werner e3d12d6769 Remove room_id from /sync examples
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
4 years ago
Kitsune Ral e310736adb
Merge pull request #2626 from matrix-org/kitsune/structures
Use public_rooms_response.yaml instead of replicating the same definition
4 years ago
Kitsune Ral 49ccfa09a8
Merge pull request #2592 from matrix-org/kitsune/fix-room-versions
capabilities.yaml: drop an extraneous title
4 years ago
Richard van der Hoff f632f4a20f
Clarify link to OpenID Connect specification (#2605)
OpenID Connect and OpenID are different things. This seems to be talking about
the former.
4 years ago
Travis Ralston 29f23a5eda
Merge pull request #2599 from matrix-org/travis/typos
Fix typos and clarify the user ID in login sections
4 years ago
Hubert Chathi cf37688b7c
Merge pull request #2387 from uhoreg/key_backup_spec
initial version of spec for key backups
4 years ago
Hubert Chathi a36284810d more clarifications and fixes 4 years ago
Travis Ralston d9a1de1d30 Fix typos and clarify the user ID in login sections 4 years ago
Hubert Chathi 40c50c80ea
Apply suggestions from code review
Co-authored-by: Travis Ralston <travpc@gmail.com>
4 years ago
Kitsune Ral bda05a0d44 capabilities.yaml: drop an extraneous title
AvailableRoomVersions sticks itself as a property type, preempting
the mention of RoomVersionStability in the generated text.
4 years ago
Kitsune Ral f299f60e17 Use public_rooms_response.yaml instead of replicating the same definition
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
4 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
4 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)
4 years ago
Travis Ralston 04a26dafd0
Merge pull request #2546 from matrix-org/travis/spec/1466-softlogout
Spec soft-logout per MSC1466
4 years ago
Travis Ralston a5cb9c655c
It's important to say who
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
4 years ago
Travis Ralston bea6b321a5
Change the nots order
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
4 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
4 years ago
Travis Ralston 669377888e Fix more typos throughout the specification
Fixes https://github.com/matrix-org/matrix-doc/issues/2193
4 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)).
4 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.
4 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
4 years ago
Travis Ralston 36ed6e94a2 Re-introduce signature schemas 4 years ago
Hubert Chathi 6a8ba9b1d6 improve description of key object in CS and include a link in Fed 4 years ago
Hubert Chathi 5b38c04e19 make definition of signatures fields more consistent 4 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
4 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).
4 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
4 years ago
Travis Ralston 74b627ac0b Fix the response format of the `/send` endpoint
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
4 years ago
Kegsay fc91946e5a
Update api/server-server/backfill.yaml
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
4 years ago
Kegan Dougal 9765116c47 Make backfill wording clearer 4 years ago
Travis Ralston 05e83f2e7d Fix more describes -> describe 4 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
4 years ago
Travis Ralston 7c0046ffc7 describes -> describe 4 years ago
Travis Ralston d419e3b38a Remove extraneous spaces 4 years ago
Dominic Fischer 28d460fb62
Fix Typo 4 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.
4 years ago
Travis Ralston d24f15a3a9 Spec soft-logout per MSC1466
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
4 years ago
Hubert Chathi fae1165e1c spec what to do if you try to delete a backup that's already deleted 4 years ago
Hubert Chathi bd95568c8c remove duplicate key 4 years ago
Hubert Chathi 1bae8ea633 we actually don't support the GET /room_key/versions/ with trailing slash 4 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.
4 years ago
Hubert Chathi a896729ac2 some more clarifications and indentation fixes 4 years ago