afead2eb1b
Clarify LL in /sync a bit more
5 years ago
e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn
...
Spec MSISDN UIA support
5 years ago
976f32fcab
Clarify that /register must produce valid Matrix User IDs
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
5 years ago
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
5 years ago
e115e3439d
Touchups on the s2s swagger definitions
...
Duplicate properties, wrong types, etc.
5 years ago
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
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:
* 00bf99fa62https://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
fc4965f274
Stronger spec words
6 years ago
aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned
...
Fix third party signed definitions for join APIs
6 years ago
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
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
8b28972a2d
PR feedback
6 years ago
010757c01d
Merge pull request #2057 from matrix-org/anoa/clarify_email_sending
...
Clarify what the client should receiving on email resending
6 years ago
0b42a17352
Update api/identity/definitions/request_email_validation.yaml
...
Co-Authored-By: Travis Ralston <travpc@gmail.com>
6 years ago
53aa8fe8ec
clarify the order events in chunk for /messages
6 years ago
dc6d89caca
Split download endpoints back apart
...
Apparently you can't have an optional path parameter.
6 years ago
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
0b45f3795b
Rename example to invite_room_state
...
This is a better representation of what it actually is
6 years ago
237d585e07
Shorten references to StrippedState in s2s spec
6 years ago
b9c4a2561f
Fix examples of StrippedState in s2s spec
6 years ago
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
d7f37f92eb
Merge branch 'master' into travis/1.0/fix-examples
6 years ago
c0c4629993
Slight word change
6 years ago
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
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
f9472bae41
Change reference for definition of push rule condition kinds
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
6 years ago
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
c25afa663e
Use consistent event examples throughout the Client-Server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
6 years ago
15b8011f63
Add missing aesthetic parameters to /store-invite
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
6 years ago
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
c5fdd5cb0b
Change note style
6 years ago
551806a8ad
Add a reference to the filtering module to /sync
6 years ago
62890d21b2
Fix example Content-Type for /media/upload request
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
6 years ago
699cafe670
v4 is v4, not v3
6 years ago
b3d86f99b9
Add room summary spec
6 years ago
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
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
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
7b266b33da
Add membership params
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1945
6 years ago
ba520df004
Move lazy loading to a section in Filtering
6 years ago
b67161cf97
List the endpoints which are lazy-loading aware
6 years ago
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)
6 years ago
d56df3238c
Generalize wording to fit /messages and /sync
6 years ago
e7ed8a23ce
Move lazy loading filter options to event filter
...
The options also work on /messages
6 years ago
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
a30dbc590d
Clarify that e2e keys are also obliterated
6 years ago
d52fcdacfa
Add M_NOT_FOUND definition for deleting non-existent aliases
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
6 years ago
221d9f24fd
Clarify that logging out deletes devices too
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
6 years ago
1d33adf62d
Add rationale for UIA on change password, and how access tokens behave
...
Fixes https://github.com/matrix-org/matrix-doc/issues/680
6 years ago
2b96d73305
Fix third party signed definitions for join APIs
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
6 years ago
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
6 years ago
3c62b90dfb
Add missing punctuation
6 years ago
14715468bb
Make thumbnail dimensions mandatory
...
Fixes #1883
6 years ago
24e0ec4bce
Replace /bind with /3pid/bind
6 years ago
baf8948eb5
Describe M_UNSUPPORTED_ROOM_VERSION on invite and createRoom endpoints
...
Spec for MSC1866: https://github.com/matrix-org/matrix-doc/pull/1866
6 years ago
d52918a892
Fix #1904 .
6 years ago
49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades
...
Clarify the recommendations for "transferable state"
6 years ago
72242e4ebb
Merge pull request #1879 from matrix-org/travis/fix-capabilities
...
Correctly nest the capabilities response object
6 years ago
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.
6 years ago
ef13aef8c3
Clarify the recommendations for "transferable state"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
6 years ago
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.
6 years ago
71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback
...
Fix contradiction in wellknown discovery for servers
6 years ago
c8428b1f8b
Fix contradiction in wellknown discovery for servers
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1854
6 years ago
3dd0601a96
Remove more TLS fingerprint talk
6 years ago
222957157f
Add missing required flags
6 years ago
1d0156ad78
Fix more titles
6 years ago
985d02d95e
Fix titles in schemas
6 years ago
82bed06d3f
The event *format* changes, not the version
6 years ago
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?
6 years ago
5d8fa65e6e
De-duplicate state keys
6 years ago
33406e4662
Apply event format warnings to the remainder of the s2s spec
6 years ago
9b214ec16d
Make the backfill response aware of event format changes
6 years ago
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
...
remove references to presence lists
6 years ago
41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk
...
Specify .well-known s2s discovery and X.509 validation
6 years ago
df01acc6e2
Merge pull request #1828 from matrix-org/travis/spec/rooms-v3
...
Add specification for room version 3: Event IDs as hashes
6 years ago
01556e5b17
Clarifications and bug fixes in how v3 rooms work
6 years ago
c888f3f080
Make example strings more legible
6 years ago
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.
6 years ago
9193d57dfd
full stop
6 years ago
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.
6 years ago
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.
6 years ago
4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect
...
Add a mechanism for redirecting clients after login
6 years ago
afd399d7d4
remove unused schema defs
6 years ago
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
c0039c30f2
Minor wording changes from code review
...
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
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
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
bf2b6e6daa
remove references to presence lists
6 years ago
84a4ca62c3
Merge pull request #1786 from matrix-org/travis/spec/exp-caps
...
Add support for unstable feature advertising via /versions
6 years ago
052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades
...
Add room version upgrades
6 years ago
413bfaeb68
Add clarification that clients shouldn't use unstable things as stable
6 years ago
f5fa7e5924
Change wording to encourage servers to make reasonable decisions
6 years ago
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
6e8739c989
Fix typo
...
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
5cbfafaab7
Fix link to module
6 years ago
b85f7bb248
Add room version upgrades
...
Implements https://github.com/matrix-org/matrix-doc/issues/1501
6 years ago
0eabf108d9
Add a mechanism for redirecting clients after login
...
Implements https://github.com/matrix-org/matrix-doc/pull/1730
6 years ago
3e7a5f5ea4
Initial draft for SSO support
6 years ago
ccc1cdaead
Add support for unstable feature advertising via /versions
...
Incorporates https://github.com/matrix-org/matrix-doc/issues/1497
6 years ago
8f1291a3e7
Merge pull request #1758 from QMatrixClient/kitsune/lazy-loading
...
Spec lazy_load_members and include_redundant_members
6 years ago
8c80669d7a
Add the paragraph for sync.yaml forgotten in the previous commit
6 years ago
1639f27ec5
Describe the actual implication of omitting contains_url
...
Closes #1750
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
6d0def8b4c
Spec lazy_load_members and include_redundant_members
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
6782b6399f
Update according to the comments
6 years ago
96d7eed1c6
joining.yaml: add missing response schema details
6 years ago
818b48cbbb
make_leave returns an `event` field too
6 years ago
e17dd12007
make_join returns its event under an `event` key
6 years ago
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
...
document device list synchronisation over federation.
6 years ago
192a6c2ab9
Use example.org on examples instead of domain.com which is a real domain
...
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
6 years ago
ee5e519885
device list is 2 words
6 years ago
928fc5cbe5
incorporate review
6 years ago
43f2819702
switch to travis' example
6 years ago
49f0a06238
experiment with additionalProperties some more
6 years ago
f6326030ba
backtick asterisk
6 years ago
7430c3b56f
experiment with additionalProperties
6 years ago
337041610f
one slash?
6 years ago
b8608495e9
periods
6 years ago
a842e0433d
try escaping the asterisk
6 years ago
42b11e096f
Review
6 years ago
db302b66ca
revert example which was corect first time; fix rst
6 years ago
2c0b45fd14
fix example?
6 years ago
0f9a23c471
swaggerify to-device
6 years ago
0ee2cf6286
fix device_list_update example hopefully
6 years ago
0afdcc59ea
spell out stream_id and fix todo
6 years ago
d377bedd76
fix path
6 years ago
30d56691b1
document device list synchronisation over federation.
...
untested
closes MSC1212
6 years ago
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar
...
Spec grammars for IS things
6 years ago
79974b152c
s/identity service/identity server
6 years ago
2af09655ce
Fix the stragglers
6 years ago
21f8898cd8
Merge remote-tracking branch 'origin/master' into rav/is_token_grammar
6 years ago
a544b68298
Merge branch 'master' into rav/is_token_grammar
6 years ago
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
6 years ago
7ac76fa27c
Actually we're going with "identity server" afterall
6 years ago
ec248b436f
Identity Service is lowercase
6 years ago
cc0badaaa1
Fix all naming cases of "identity service"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1396
Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
683072e624
Merge pull request #1636 from turt2live/travis/c2s/id-server
...
Clean up and flesh out all three editions of the /requestToken API
6 years ago
a1f655e5be
Fix more error wording
6 years ago
1261da209d
Fix wording for the homeserver not allowing a particular 3pid
6 years ago
cb1e687196
spec the format of an IS invite token
6 years ago
69c30ef156
spec the format of a client_secret
6 years ago
dced3d5707
Notes on the format of IS session IDs and tokens
6 years ago
824ce22caa
Add additional clarity to the requestToken errors
6 years ago
5bb7eca8e8
English
6 years ago
60dd9231e0
Don't explain how the IS might accept a 3pid
...
The IS is bound to it's own set of specifications, and if the client chose this API then they should be aware of the risks but not necessarily arbitrary alternatives.
6 years ago
63fdd72f73
Fix error description on /account/3pid/email/requestToken
6 years ago
f6d9e53f5c
Clarify that homeserver must reject clients from setting m.fully_read
6 years ago
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
6 years ago
a4c2b2b905
General clarity and spelling for the requestToken APIs
6 years ago
7f1b94c211
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server
6 years ago
e3ad253dca
A sender is also required for the invite_state
6 years ago
Travis Ralston