Commit Graph

1216 Commits (ab64bda76dcefcff2fcf4e050427409b9d0068af)

Author SHA1 Message Date
Hubert Chathi 41072fcaa9
Apply suggestions from code review
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
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
Hubert Chathi a62c817745
Apply suggestions from code review
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
5 years ago
Hubert Chathi 4cde800ea1 fix validation errors 5 years ago
Hubert Chathi 59e337187b remove duplicated line 5 years ago
Hubert Chathi e658b17070 initial version of spec for key backups 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
Travis Ralston b662a33081 Recommend that clients don't preview URLs in encrypted rooms
Any stronger of a recommendation would probably require a MSC due to the behaviour change. 

Fixes https://github.com/matrix-org/matrix-doc/issues/2120
5 years ago
Travis Ralston 284b15495b Clarify what format the `country` is on phone number inputs
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
5 years ago
Travis Ralston e95eafb2ba Clarify that submit_url is without authentication
The request is authorized by its parameters, not by an additional access token.

Fixes https://github.com/matrix-org/matrix-doc/issues/2298
5 years ago
Travis Ralston 2bca44a2e5 Remove extraneous backwards compatibility note 5 years ago
Travis Ralston f5f12a29e0 Spec MSC2290: 3PID binding split 5 years ago
Travis Ralston 3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server
Deprecate id_server and make it optional
5 years ago
Travis Ralston 48b8a95df6 Deprecate id_server and make it optional
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
5 years ago
Kitsune Ral 6b37bb1dd9 Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support 5 years ago
Travis Ralston 8d865ca53a Add s2s POST /publicRooms per MSC2197
See https://github.com/matrix-org/matrix-doc/pull/2197
5 years ago
Travis Ralston 2c88f02daa
Merge pull request #2287 from matrix-org/travis/spec/lookup-v2
Spec the v2 lookup API
5 years ago
Travis Ralston d813b8e12c Mention M_INVALID_PARAM 5 years ago
Travis Ralston 6cfd761204 Spec the v2 lookup API
Spec for [MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134)
5 years ago
Travis Ralston 642be6c677 Fix unbind wording 5 years ago
Travis Ralston 30a9de7e02 Merge branch 'master' into travis/spec/is-unbind 5 years ago
Travis Ralston a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms
Spec IS terms of service
5 years ago
Travis Ralston 1881a255c2 Clarify that id_access_token is optional for r0.5 5 years ago
Travis Ralston 185c564a13 Spec client-server IS unbind API
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140)

Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
5 years ago
Travis Ralston 2d784d93ef Merge branch 'master' into travis/spec/is-auth 5 years ago
Travis Ralston 001c51a740 /3pid/delete and /deactivate don't take an id_access_token 5 years ago
Travis Ralston 52e6868f50 Remove bind_* params on /register as per MSC2140
See https://github.com/matrix-org/matrix-doc/pull/2140
See https://github.com/matrix-org/matrix-doc/issues/2253
5 years ago
Travis Ralston afd5018494 Spec the terms of service handling for identity servers
Part of MSC2140

Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
5 years ago
Travis Ralston 0408373cf9 Litter the client-server API with id_access_token 5 years ago
Travis Ralston 4d0ea64121 Define authentication, ripping off the client-server API description 5 years ago
Travis Ralston e40d9e296d Split OpenID token info out verbatim 5 years ago
Travis Ralston ca4d9d8636 Deprecate the v1 IS API 5 years ago
Travis Ralston a47c5aeb42 v2-ify the v2 api
Note that ping and pubkey doesn't require auth - see MSC2140 for more information.
5 years ago
Travis Ralston 5b53b3d0b8 Clone v1 APIs verbatim 5 years ago
Travis Ralston b8a3f970ee Add security definition for access token 5 years ago
Kitsune Ral 65cd10249c Render enums inside additionalProps as one more table
Closes #2242.
5 years ago
Andrew Morgan 92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes (#2234)
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181).

Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
5 years ago
Dominic Fischer a63fab20ee Fix some typos
Signed-off-by: Dominic Fischer <dominicfischer7@gmail.com>
5 years ago
Andrew Morgan af60889eee
Clarify that /rooms/{roomId}/event/{eventId}'s 404 should be M_NOT_FOUND (#2204)
No error code is specified for this endpoint's 404. State that it should be an `M_NOT_FOUND`.
5 years ago
Travis Ralston 2a2dddab94
Merge pull request #2151 from reivilibre/push_id_event_id
Fix Push Gateway API example: Field renamed to event_id
5 years ago
Alexey Andreyev 9ed19a37ad
Client-server: Fix upload keys example request
Contributes to #1733

Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
5 years ago
J. Ryan Stinnett 4c65660b96 Clarify `.m.rule.room_one_to_one` push rule
This clarifies the `.m.rule.room_one_to_one` push rule by adding a condition on
event type. Some parts of the spec already had this info, while others were
missing it. Synapse has had this behaviour since the push rule appeared.

Fixes https://github.com/matrix-org/matrix-doc/issues/2150
5 years ago
reivilibre 8033ab1c86 Fix Push Gateway API example: Field renamed to event_id
I believe this was forgotten in:
71cb646541
5 years ago
Travis Ralston cac72ff873
Merge pull request #2126 from matrix-org/travis/403-id-unbind
Add 403 error to IS unbind
6 years ago
Travis Ralston 67ea3b9ce8 Add 403 error to IS unbind
Fixes https://github.com/matrix-org/matrix-doc/issues/2117
6 years ago
Travis Ralston b8f1f37927 Remove incorrect id_server param from IS spec
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
6 years ago
Travis Ralston 8f1f8b4fe5 Fix references to filtering
We can't have two different backlinks for the same text, so use LL as the label
6 years ago
Travis Ralston 8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object
Clarify the key object definition for the key management API
6 years ago
Travis Ralston 8b7887dfc2 Link to key algorithms section 6 years ago
Travis Ralston 19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
Spec lazy-loading room members
6 years ago
Travis Ralston fbdb56a29f
Merge pull request #2101 from matrix-org/anoa/hs_3pid_tokens
Add submit_url field to requestToken responses, clarify HS's can send tokens themselves
6 years ago
Travis Ralston 56745c76aa Clarify that submit_url being not present only matters for r0.5 6 years ago
Travis Ralston 85f34f942f Fix invalid doc error
Another annoying case of Swagger fighting us
6 years ago
Travis Ralston f7aa2adfb4 Fix indentation 6 years ago
Travis Ralston 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
6 years ago
Travis Ralston ca8b539b2f humans prefer to be treated as people 6 years ago
Travis Ralston 370ae8b9fe
Merge pull request #2068 from matrix-org/travis/1.0/mxc
Refactor documentation for content/media repository
6 years ago
Travis Ralston b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
Specify some of the common concepts for Matrix in the index
6 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
6 years ago
Travis Ralston 39b79fe453
Merge pull request #2088 from matrix-org/travis/1.0/duplicate-state-endpoint
Merge GET/PUT /state/:event_type endpoints
6 years ago
Andrew Morgan 5f24f63338 Better wording 6 years ago
Andrew Morgan 1a22508e15 identity server -> the server 6 years ago
Travis Ralston 1886a2346a Move explanation of notifications to notifications module 6 years ago
Travis Ralston cf19f52576 Enforce 7 day validity requirement everywhere
also misc formatting fixes
6 years ago
Matthew Hodgson 0506d09cf7 incorporate LL review from matthew 6 years ago
Travis Ralston f047e235df Merge branch 'master' into travis/1.0/event-ids 6 years ago
Travis Ralston 6d62a1b444
Merge pull request #2084 from matrix-org/travis/1.0/s2s-swagger-touchups
Touchups on the s2s swagger definitions
6 years ago
Andrew Morgan 2068cba598 Clients should submit a POST request 6 years ago
Andrew Morgan 7116f9334e More consolidation 6 years ago
Andrew Morgan d1fde0837a Consolidate id_server into ref. id_server/next_link are ignored 6 years ago
Andrew Morgan ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 6 years ago
Andrew Morgan fe23de7d7f A SMS -> An SMS 6 years ago
Andrew Morgan 046a834488 Slight code cleanup 6 years ago
Andrew Morgan 2551ff6ce0 Actually check in code 6 years ago
Andrew Morgan 525bedf8e1 Fix refs 6 years ago
Andrew Morgan fba61941af Move submit_url responses to ref 6 years ago
Andrew Morgan 0ded484276 Address review comments 6 years ago
Andrew Morgan 1776ba28d3 Address review comments 6 years ago
Andrew Morgan a8edb066aa Clear up some wording 6 years ago
Andrew Morgan 8a6ef187db more object! 6 years ago
Travis Ralston a38af2009f
Apply suggestions from code review
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
6 years ago
Travis Ralston 906d3cd447
Merge pull request #2055 from matrix-org/travis/1.0/registration-clarification
Clarify guest accounts and `auth` usage on /register
6 years ago
Andrew Morgan 62910a28cc Merge branch 'master' into anoa/hs_3pid_tokens
* master:
  Update example
  Fix 404s in links from room v1 spec
  Provide a more complete example of a "minimally-sized event"
  Revert signature change for redactable event test
  Clarify how many PDUs are in a given transaction object
  Clarify that the server shouldn't process retries for UIA
  Clarify when authorization and rate-limiting are not applicable
  Skip over partial event definitions in examples
  Rename example to invite_room_state
  Shorten references to StrippedState in s2s spec
  Fix examples of StrippedState in s2s spec
  Clarify exactly what StrippedState is
  Clarify that UIA stages cannot be attempted twice
  Fix test vectors with invalid JSON and signature
  Spec 3PID unbind API
  Spec MSISDN UIA support
6 years ago
Andrew Morgan 3148184052 HS' can send 3PID token. Add a new submit_url field 6 years ago
Travis Ralston a0e8201816
Apply suggestions from code review
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
6 years ago
Travis Ralston 77c4c4b07c Add general clarity 6 years ago
Travis Ralston 9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind
Spec 3PID unbind API
6 years ago
Travis Ralston 70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state
Clarify exactly what StrippedState is
6 years ago
Travis Ralston b9c9396c11 Specify some of the common concepts for Matrix in the index
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528

The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
6 years ago
Travis Ralston f0eb495cee Clarify how notification counts are calculated in /sync
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
6 years ago
Travis Ralston 9bf0103ef3 Clarify how many PDUs are in a given transaction object
Fixes https://github.com/matrix-org/matrix-doc/issues/2093
6 years ago
Travis Ralston afead2eb1b Clarify LL in /sync a bit more 6 years ago
Travis Ralston e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn
Spec MSISDN UIA support
6 years ago
Travis Ralston 976f32fcab Clarify that /register must produce valid Matrix User IDs
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
6 years ago
Travis Ralston c8a3850598 Merge GET/PUT /state/:event_type endpoints
Clarifying that the state key is optional, and how that works.

Fixes https://github.com/matrix-org/matrix-doc/issues/1182
6 years ago
Travis Ralston e115e3439d Touchups on the s2s swagger definitions
Duplicate properties, wrong types, etc.
6 years ago
Travis Ralston a19eb59f13 Clarify the key object definition for the key management API
Fixes https://github.com/matrix-org/matrix-doc/issues/1907


One too far
6 years ago
Travis Ralston a6314df44c Spec v5 rooms: Key validity
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076)
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077)

Implementation references:
* 00bf99fa62
* https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321

No known differences from the proposals are included here - alterations are accidental.
6 years ago
Travis Ralston fc4965f274 Stronger spec words 6 years ago
Travis Ralston aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned
Fix third party signed definitions for join APIs
6 years ago
Travis Ralston e8d6a57a2e
Merge pull request #2052 from matrix-org/travis/1.0/pushrules-kind
Change reference for definition of push rule condition kinds
6 years ago
Travis Ralston 9dd171a718
Merge pull request #2069 from matrix-org/bwindels/messages-chunk-order
Clarify the order events in chunk are returned in for /messages
6 years ago
Bruno Windels 8b28972a2d PR feedback 6 years ago
Travis Ralston 010757c01d
Merge pull request #2057 from matrix-org/anoa/clarify_email_sending
Clarify what the client should receiving on email resending
6 years ago
Andrew Morgan 0b42a17352
Update api/identity/definitions/request_email_validation.yaml
Co-Authored-By: Travis Ralston <travpc@gmail.com>
6 years ago
Bruno Windels 53aa8fe8ec clarify the order events in chunk for /messages 6 years ago
Travis Ralston dc6d89caca Split download endpoints back apart
Apparently you can't have an optional path parameter.
6 years ago
Travis Ralston 1f86e8e31b Refactor documentation for content/media repository
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
6 years ago
Travis Ralston 0b45f3795b Rename example to invite_room_state
This is a better representation of what it actually is
6 years ago
Travis Ralston 237d585e07 Shorten references to StrippedState in s2s spec 6 years ago
Travis Ralston b9c4a2561f Fix examples of StrippedState in s2s spec 6 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.
6 years ago
Travis Ralston d7f37f92eb Merge branch 'master' into travis/1.0/fix-examples 6 years ago
Andrew Morgan c0c4629993
Slight word change 6 years ago
Andrew Morgan 6ae7e49522
Clarify what the client should receiving on email resending
It was a little unclear what the client should do when asked to send a validation email and provides a `send_attempt` value that is not greater than previous attempts. As this is intended to be for when a client mistakenly sends the request twice, it makes logical sense that the implication was to simply resend a success value so the client doesn't error even when an email may have been sent on the first attempt.

This behaviour was also mimicked in Synapse/Sydent.
6 years ago
Travis Ralston 2ed37f5bf4 Clarify guest accounts and `auth` usage on /register
Fixes https://github.com/matrix-org/matrix-doc/issues/1980
Fixes https://github.com/matrix-org/matrix-doc/issues/1984
6 years ago
Travis Ralston f9472bae41 Change reference for definition of push rule condition kinds
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
6 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.
6 years ago
Travis Ralston c25afa663e Use consistent event examples throughout the Client-Server API
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
6 years ago
Travis Ralston 15b8011f63 Add missing aesthetic parameters to /store-invite
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
6 years ago
Travis Ralston 0463084924 Spec 3PID unbind API
As per [MSC1915](https://github.com/matrix-org/matrix-doc/pull/1915)

Implementation proof: 
* https://github.com/matrix-org/synapse/pull/4982
* https://github.com/matrix-org/sydent/pull/160

The only alteration made which differs from the proposal is clarity on how to handle homeservers not knowing the `id_server`. All other differences are unintentional.
6 years ago
Travis Ralston c5fdd5cb0b Change note style 6 years ago
Travis Ralston 551806a8ad Add a reference to the filtering module to /sync 6 years ago
Travis Ralston 62890d21b2 Fix example Content-Type for /media/upload request
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
6 years ago
Travis Ralston 699cafe670 v4 is v4, not v3 6 years ago
Travis Ralston b3d86f99b9 Add room summary spec 6 years ago
Travis Ralston e610f085a9
Merge pull request #2019 from matrix-org/travis/1.0/msc1884-msc2002-v4-rooms
Add version 4 rooms to the spec
6 years ago
Travis Ralston 40cf4620d5
Merge pull request #2027 from matrix-org/travis/1.0/pw-change-uia
Add rationale for UIA on change password, and how access tokens behave
6 years ago
Travis Ralston 1aa71f2436
Merge pull request #2029 from matrix-org/travis/1.0/delete-alias
Add M_NOT_FOUND definition for deleting non-existent aliases
6 years ago
Travis Ralston 7b266b33da Add membership params
Fixes https://github.com/matrix-org/matrix-doc/issues/1945
6 years ago
Travis Ralston ba520df004 Move lazy loading to a section in Filtering 6 years ago
Travis Ralston b67161cf97 List the endpoints which are lazy-loading aware 6 years ago
Travis Ralston 34d6c1f4ad Clarify wording further for how to handle redundant members
Note: This makes assumptions on what the TODO comment in Synapse means: e26e6b3230/synapse/handlers/pagination.py (L262)

Due to lack of implementation, it is assumed that using the same filter across multiple calls to /sync OR /messages will result in the redundant members being excluded in the next request. For example, calling /sync, then /messages which returns some members, then /sync again will exclude the members due to them being in /messages.
6 years ago
Travis Ralston d56df3238c Generalize wording to fit /messages and /sync 6 years ago
Travis Ralston e7ed8a23ce Move lazy loading filter options to event filter
The options also work on /messages
6 years ago
Travis Ralston 1bda3fe2b2 Spec MSISDN UIA support
Fixes https://github.com/matrix-org/matrix-doc/issues/1702

1702 describes the lack of `bind_msisdn` parameter, however the whole login type was missing from UIA.
6 years ago
Travis Ralston a30dbc590d Clarify that e2e keys are also obliterated 6 years ago
Travis Ralston d52fcdacfa Add M_NOT_FOUND definition for deleting non-existent aliases
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
6 years ago
Travis Ralston 221d9f24fd Clarify that logging out deletes devices too
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
6 years ago