Commit Graph

1060 Commits (2cafa7e1e878503c7d71d6c3ac21d66c516c84cd)

Author SHA1 Message Date
Travis Ralston e115e3439d Touchups on the s2s swagger definitions
Duplicate properties, wrong types, etc.
5 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
5 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.
5 years ago
Travis Ralston fc4965f274 Stronger spec words 5 years ago
Travis Ralston aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned
Fix third party signed definitions for join APIs
5 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
5 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
5 years ago
Bruno Windels 8b28972a2d PR feedback 5 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
5 years ago
Andrew Morgan 0b42a17352
Update api/identity/definitions/request_email_validation.yaml
Co-Authored-By: Travis Ralston <travpc@gmail.com>
5 years ago
Bruno Windels 53aa8fe8ec clarify the order events in chunk for /messages 5 years ago
Travis Ralston dc6d89caca Split download endpoints back apart
Apparently you can't have an optional path parameter.
5 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
5 years ago
Travis Ralston 0b45f3795b Rename example to invite_room_state
This is a better representation of what it actually is
5 years ago
Travis Ralston 237d585e07 Shorten references to StrippedState in s2s spec 5 years ago
Travis Ralston b9c4a2561f Fix examples of StrippedState in s2s spec 5 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.
5 years ago
Travis Ralston d7f37f92eb Merge branch 'master' into travis/1.0/fix-examples 5 years ago
Andrew Morgan c0c4629993
Slight word change 5 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.
5 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
5 years ago
Travis Ralston f9472bae41 Change reference for definition of push rule condition kinds
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
5 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.
5 years ago
Travis Ralston c25afa663e Use consistent event examples throughout the Client-Server API
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
5 years ago
Travis Ralston 15b8011f63 Add missing aesthetic parameters to /store-invite
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
5 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.
5 years ago
Travis Ralston c5fdd5cb0b Change note style 5 years ago
Travis Ralston 551806a8ad Add a reference to the filtering module to /sync 5 years ago
Travis Ralston 62890d21b2 Fix example Content-Type for /media/upload request
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
5 years ago
Travis Ralston 699cafe670 v4 is v4, not v3 5 years ago
Travis Ralston b3d86f99b9 Add room summary spec 5 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
5 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
5 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
5 years ago
Travis Ralston 7b266b33da Add membership params
Fixes https://github.com/matrix-org/matrix-doc/issues/1945
5 years ago
Travis Ralston ba520df004 Move lazy loading to a section in Filtering 5 years ago
Travis Ralston b67161cf97 List the endpoints which are lazy-loading aware 5 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.
5 years ago
Travis Ralston d56df3238c Generalize wording to fit /messages and /sync 5 years ago
Travis Ralston e7ed8a23ce Move lazy loading filter options to event filter
The options also work on /messages
5 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.
5 years ago
Travis Ralston a30dbc590d Clarify that e2e keys are also obliterated 5 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
5 years ago
Travis Ralston 221d9f24fd Clarify that logging out deletes devices too
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
5 years ago
Travis Ralston 1d33adf62d Add rationale for UIA on change password, and how access tokens behave
Fixes https://github.com/matrix-org/matrix-doc/issues/680
5 years ago
Travis Ralston 2b96d73305 Fix third party signed definitions for join APIs
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
5 years ago
Travis Ralston 3b0e194ff7 Add version 4 rooms to the spec
As per [MSC1884](https://github.com/matrix-org/matrix-doc/pull/1884) and [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002).

No known changes since the proposals were accepted.

Due to being in the area: This fixes https://github.com/matrix-org/matrix-doc/issues/1863
5 years ago
Andrew Morgan 3c62b90dfb Add missing punctuation 5 years ago
Richard van der Hoff 14715468bb Make thumbnail dimensions mandatory
Fixes #1883
5 years ago
aqtusia 24e0ec4bce
Replace /bind with /3pid/bind 5 years ago
Travis Ralston baf8948eb5 Describe M_UNSUPPORTED_ROOM_VERSION on invite and createRoom endpoints
Spec for MSC1866: https://github.com/matrix-org/matrix-doc/pull/1866
5 years ago
Anatoly Sablin d52918a892 Fix #1904. 5 years ago
Travis Ralston 49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades
Clarify the recommendations for "transferable state"
5 years ago
Travis Ralston 72242e4ebb
Merge pull request #1879 from matrix-org/travis/fix-capabilities
Correctly nest the capabilities response object
5 years ago
Travis Ralston d31d2f5e57 Correctly nest the capabilities response object
Everything is contained in a "capabilities" property, which is not represented by the schema. The example was correct.
5 years ago
Travis Ralston ef13aef8c3 Clarify the recommendations for "transferable state"
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
5 years ago
Travis Ralston 6bbf22cd04 Add routes for retrieving account data
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1339

This contains no known differences to what was ultimately decided upon and implemented.
5 years ago
Travis Ralston 71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback
Fix contradiction in wellknown discovery for servers
5 years ago
Travis Ralston c8428b1f8b Fix contradiction in wellknown discovery for servers
Fixes https://github.com/matrix-org/matrix-doc/issues/1854
5 years ago
Travis Ralston 3dd0601a96 Remove more TLS fingerprint talk 5 years ago
Travis Ralston 222957157f Add missing required flags 5 years ago
Travis Ralston 1d0156ad78 Fix more titles 5 years ago
Travis Ralston 985d02d95e Fix titles in schemas 5 years ago
Travis Ralston 82bed06d3f The event *format* changes, not the version 5 years ago
Travis Ralston 890fb1a019 Fix examples for new schema
Fix missed example in make_join

Fix state array in response of send_join

Try removing examples from send_join?

Try printing more information about the error

Copy/paste known working examples

Try schema definitions in the response?
5 years ago
Travis Ralston 5d8fa65e6e De-duplicate state keys 5 years ago
Travis Ralston 33406e4662 Apply event format warnings to the remainder of the s2s spec 5 years ago
Travis Ralston 9b214ec16d Make the backfill response aware of event format changes 5 years ago
Travis Ralston e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
remove references to presence lists
5 years ago
Travis Ralston 41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk
Specify .well-known s2s discovery and X.509 validation
5 years ago
Travis Ralston df01acc6e2
Merge pull request #1828 from matrix-org/travis/spec/rooms-v3
Add specification for room version 3: Event IDs as hashes
5 years ago
Travis Ralston 01556e5b17 Clarifications and bug fixes in how v3 rooms work 5 years ago
Travis Ralston c888f3f080 Make example strings more legible 5 years ago
Travis Ralston 0347e873ef Specify .well-known s2s discovery and X.509 validation
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824)
* https://github.com/matrix-org/matrix-doc/pull/1711

Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.

There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
5 years ago
Travis Ralston 9193d57dfd full stop 5 years ago
Travis Ralston ccce6c196d Specify how capabilities work in the c2s API
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804

Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830

There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
5 years ago
Travis Ralston ff75996524 Add specification for room version 3: Event IDs as hashes
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499

This doesn't intentionally change anything from the proposal.

**Implementation details**:

The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.

Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.

The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
5 years ago
Travis Ralston 4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect
Add a mechanism for redirecting clients after login
5 years ago
Neil Johnson afd399d7d4 remove unused schema defs 5 years ago
Travis Ralston d2b35e5150
Merge pull request #1821 from matrix-org/travis/spec/rver-make-memberships
Specify the room_version response property on /make_{leave|join}
6 years ago
Erik Johnston c0039c30f2
Minor wording changes from code review
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
Travis Ralston d12593feea Specify the room_version response property on /make_{leave|join}
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1813
Implementation proof: https://github.com/matrix-org/synapse/pull/4447

There are no changes from the original proposal.
6 years ago
Travis Ralston aca9437bf3 Specification for v2 s2s invite API
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1794
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4402
* https://github.com/matrix-org/synapse/pull/4496

There are no changes from the original proposal.
6 years ago
Neil Johnson bf2b6e6daa remove references to presence lists 6 years ago
Travis Ralston 84a4ca62c3
Merge pull request #1786 from matrix-org/travis/spec/exp-caps
Add support for unstable feature advertising via /versions
6 years ago
Travis Ralston 052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades
Add room version upgrades
6 years ago
Travis Ralston 413bfaeb68 Add clarification that clients shouldn't use unstable things as stable 6 years ago
Travis Ralston f5fa7e5924 Change wording to encourage servers to make reasonable decisions 6 years ago
Travis Ralston aeb524ef89 Remove CAS login and reference it against r0.4.0
The SSO module should cover what CAS provides, and r0.4.0 is good as a reference for how CAS could be implemented without us repeating it here.
6 years ago
Richard van der Hoff 6e8739c989
Fix typo
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
Travis Ralston 5cbfafaab7 Fix link to module 6 years ago
Travis Ralston b85f7bb248 Add room version upgrades
Implements https://github.com/matrix-org/matrix-doc/issues/1501
6 years ago
Travis Ralston 0eabf108d9 Add a mechanism for redirecting clients after login
Implements https://github.com/matrix-org/matrix-doc/pull/1730
6 years ago
Travis Ralston 3e7a5f5ea4 Initial draft for SSO support 6 years ago
Travis Ralston ccc1cdaead Add support for unstable feature advertising via /versions
Incorporates https://github.com/matrix-org/matrix-doc/issues/1497
6 years ago
Richard van der Hoff 8f1291a3e7
Merge pull request #1758 from QMatrixClient/kitsune/lazy-loading
Spec lazy_load_members and include_redundant_members
6 years ago
Kitsune Ral 8c80669d7a Add the paragraph for sync.yaml forgotten in the previous commit 6 years ago
Kitsune Ral 1639f27ec5 Describe the actual implication of omitting contains_url
Closes #1750

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Kitsune Ral 6d0def8b4c Spec lazy_load_members and include_redundant_members
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Kitsune Ral 6782b6399f
Update according to the comments 6 years ago