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
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
6 years ago
Travis Ralston
2b96d73305
Fix third party signed definitions for join APIs
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
6 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
6 years ago
Andrew Morgan
3c62b90dfb
Add missing punctuation
6 years ago
Richard van der Hoff
14715468bb
Make thumbnail dimensions mandatory
...
Fixes #1883
6 years ago
aqtusia
24e0ec4bce
Replace /bind with /3pid/bind
6 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
6 years ago
Anatoly Sablin
d52918a892
Fix #1904 .
6 years ago
Travis Ralston
49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades
...
Clarify the recommendations for "transferable state"
6 years ago
Travis Ralston
72242e4ebb
Merge pull request #1879 from matrix-org/travis/fix-capabilities
...
Correctly nest the capabilities response object
6 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.
6 years ago
Travis Ralston
ef13aef8c3
Clarify the recommendations for "transferable state"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
6 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.
6 years ago
Travis Ralston
71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback
...
Fix contradiction in wellknown discovery for servers
6 years ago
Travis Ralston
c8428b1f8b
Fix contradiction in wellknown discovery for servers
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1854
6 years ago
Travis Ralston
3dd0601a96
Remove more TLS fingerprint talk
6 years ago
Travis Ralston
222957157f
Add missing required flags
6 years ago
Travis Ralston
1d0156ad78
Fix more titles
6 years ago
Travis Ralston
985d02d95e
Fix titles in schemas
6 years ago
Travis Ralston
82bed06d3f
The event *format* changes, not the version
6 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?
6 years ago
Travis Ralston
5d8fa65e6e
De-duplicate state keys
6 years ago
Travis Ralston
33406e4662
Apply event format warnings to the remainder of the s2s spec
6 years ago
Travis Ralston
9b214ec16d
Make the backfill response aware of event format changes
6 years ago
Travis Ralston
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
...
remove references to presence lists
6 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
6 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
6 years ago
Travis Ralston
01556e5b17
Clarifications and bug fixes in how v3 rooms work
6 years ago
Travis Ralston
c888f3f080
Make example strings more legible
6 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.
6 years ago
Travis Ralston
9193d57dfd
full stop
6 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.
6 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.
6 years ago
Travis Ralston
4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect
...
Add a mechanism for redirecting clients after login
6 years ago
Neil Johnson
afd399d7d4
remove unused schema defs
6 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
Kitsune Ral
96d7eed1c6
joining.yaml: add missing response schema details
6 years ago
Richard van der Hoff
818b48cbbb
make_leave returns an `event` field too
6 years ago
Richard van der Hoff
e17dd12007
make_join returns its event under an `event` key
6 years ago
Matthew Hodgson
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
...
document device list synchronisation over federation.
6 years ago
Konstantinos Sideris
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
Matthew Hodgson
ee5e519885
device list is 2 words
6 years ago
Matthew Hodgson
928fc5cbe5
incorporate review
6 years ago
Matthew Hodgson
43f2819702
switch to travis' example
6 years ago
Matthew Hodgson
49f0a06238
experiment with additionalProperties some more
6 years ago
Matthew Hodgson
f6326030ba
backtick asterisk
6 years ago
Matthew Hodgson
7430c3b56f
experiment with additionalProperties
6 years ago
Matthew Hodgson
337041610f
one slash?
6 years ago
Matthew Hodgson
b8608495e9
periods
6 years ago
Matthew Hodgson
a842e0433d
try escaping the asterisk
6 years ago
Matthew Hodgson
42b11e096f
Review
6 years ago
Matthew Hodgson
db302b66ca
revert example which was corect first time; fix rst
6 years ago
Matthew Hodgson
2c0b45fd14
fix example?
6 years ago
Matthew Hodgson
0f9a23c471
swaggerify to-device
6 years ago
Matthew Hodgson
0ee2cf6286
fix device_list_update example hopefully
6 years ago
Matthew Hodgson
0afdcc59ea
spell out stream_id and fix todo
6 years ago
Matthew Hodgson
d377bedd76
fix path
6 years ago
Matthew Hodgson
30d56691b1
document device list synchronisation over federation.
...
untested
closes MSC1212
6 years ago
Travis Ralston
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar
...
Spec grammars for IS things
6 years ago
Richard van der Hoff
79974b152c
s/identity service/identity server
6 years ago
Travis Ralston
2af09655ce
Fix the stragglers
6 years ago
Richard van der Hoff
21f8898cd8
Merge remote-tracking branch 'origin/master' into rav/is_token_grammar
6 years ago
Richard van der Hoff
a544b68298
Merge branch 'master' into rav/is_token_grammar
6 years ago
Travis Ralston
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
6 years ago
Travis Ralston
7ac76fa27c
Actually we're going with "identity server" afterall
6 years ago
Travis Ralston
ec248b436f
Identity Service is lowercase
6 years ago
Travis Ralston
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
Travis Ralston
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
Travis Ralston
a1f655e5be
Fix more error wording
6 years ago
Travis Ralston
1261da209d
Fix wording for the homeserver not allowing a particular 3pid
6 years ago
Richard van der Hoff
cb1e687196
spec the format of an IS invite token
6 years ago
Richard van der Hoff
69c30ef156
spec the format of a client_secret
6 years ago
Richard van der Hoff
dced3d5707
Notes on the format of IS session IDs and tokens
6 years ago
Travis Ralston
824ce22caa
Add additional clarity to the requestToken errors
6 years ago
Travis Ralston
5bb7eca8e8
English
6 years ago
Travis Ralston
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
Travis Ralston
63fdd72f73
Fix error description on /account/3pid/email/requestToken
6 years ago
Travis Ralston
f6d9e53f5c
Clarify that homeserver must reject clients from setting m.fully_read
6 years ago
Travis Ralston
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
6 years ago
Travis Ralston
a4c2b2b905
General clarity and spelling for the requestToken APIs
6 years ago
Travis Ralston
7f1b94c211
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server
6 years ago
Travis Ralston
e3ad253dca
A sender is also required for the invite_state
6 years ago
Travis Ralston
2f824df8dd
Define the real event types on the invite_state
6 years ago
Travis Ralston
2e3e189ea2
Merge remote matrix-org/master
6 years ago
Travis Ralston
38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite
...
Clarify how third party invites work
6 years ago
Travis Ralston
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
6 years ago
Travis Ralston
73736d41db
Merge pull request #1569 from turt2live/travis/c2s/user-directory
...
Clarify the homeserver's behaviour for user searching
6 years ago
Travis Ralston
4bd23a9086
send_attempt is no longer optional
6 years ago
Travis Ralston
7f719b23e7
Merge pull request #1589 from turt2live/travis/c2s/inhibit-login
...
Document the inhibit_login registration option
6 years ago
Travis Ralston
dfaed5b525
Clean up and flesh out all three editions of the /requestToken API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1634
Addresses some of https://github.com/matrix-org/matrix-doc/issues/1396
6 years ago
Travis Ralston
ce14779af1
Merge pull request #1567 from turt2live/travis/c2s/3pid-binding
...
Document `validated_at`, `added_at`, and POST /3pid/delete
6 years ago
Travis Ralston
5da3072eef
Wording change ('may not' has a special meaning)
6 years ago
Travis Ralston
2a08a308f3
device_keys are required
6 years ago
Travis Ralston
219b27b182
Merge remote matrix-org/master
6 years ago
Travis Ralston
f923d08078
Add read markers
...
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910
Fixes https://github.com/matrix-org/matrix-doc/issues/910
Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.
References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
6 years ago
Richard van der Hoff
0f84c69805
Merge branch 'master' into rav/clarify_event_signing
6 years ago
Travis Ralston
8bcd7d26e3
/3pid/delete returns an empty object
6 years ago
Travis Ralston
390f1c16f7
Remove mentions of identity services from /3pid/delete
...
This will be covered by https://github.com/matrix-org/matrix-doc/issues/1194
For now, we can accept that homeservers may try to unbind, however clients should not rely on it.
6 years ago
Travis Ralston
86c85aea71
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/3pid-binding
6 years ago
Travis Ralston
d57b977a55
Merge branch 'm-master' into travis/general/3pid_invite
6 years ago
Travis Ralston
e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
...
Touch up more of the identity service specification
6 years ago
Travis Ralston
f09db16027
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt
6 years ago
Travis Ralston
49c5677969
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/user-directory
6 years ago
Travis Ralston
f04afaa9b9
Merge pull request #780 from mujx/missing-enum-fields
...
Add missing enum fields for the set_presence parameter
6 years ago
Travis Ralston
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
6 years ago
Travis Ralston
0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
...
Application service spec cleanup; Security definitions; r0 prep
6 years ago
Travis Ralston
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
6 years ago
Travis Ralston
6b52e1df77
Merge pull request #1587 from turt2live/travis/s2s/clarify-state-ids-inclusion
...
Clarify that the requested event is excluded from /state and /state_ids
6 years ago
Richard van der Hoff
55c4307f12
Rewrite the section on signing events
...
... for clarity and de-duplication. And to say a bit about validating the
signatures.
6 years ago
Travis Ralston
7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state
...
Document 403 error for sending state events
6 years ago
Travis Ralston
a5c3924492
Merge remote matrix-org/master
6 years ago
Travis Ralston
f030d19f3c
Clean up identity service swagger
...
* Add `consumes` (swagger)
* Remove `http` as a supported scheme (the spec specifically says clients MUST use https)
* Clarify various descriptions
* Full stops
* Additional wording
* s/older versions/previous drafts - we haven't had a release yet
* Indentation on examples
6 years ago
Travis Ralston
684d80c422
Revert changes to 3pid lookup types in the IS spec
...
The validator doesn't know what a "3PID Medium" is, for example, so it throws exceptions. This does reduce clarity in the spec though.
6 years ago
Travis Ralston
abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
...
Identity Service API cleanup
6 years ago
Travis Ralston
c03f2f8d79
Minor touchups to the room tagging API
...
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
6 years ago
Kitsune Ral
9bc1470305
Elaborate the structure of m.tag events
...
...and corresponding structures in tag-related CS API calls
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Travis Ralston
f2d02c9559
Take out device management section for now
...
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
6 years ago
Travis Ralston
5ff244f06b
More clarification about how /state_ids works
6 years ago
Travis Ralston
de36d97839
Clarify which event is actually be excluded from /state_ids
6 years ago
Hubert Chathi
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
6 years ago
Erik Johnston
7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size
...
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
Travis Ralston
d91395cf9f
Document 403 error for sending state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1399
6 years ago
Travis Ralston
1051aff108
Document the inhibit_login registration option
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
6 years ago
Travis Ralston
dad037170a
Clarify that the requested event is excluded from /state and /state_ids
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1564
6 years ago
Travis Ralston
436544b8f8
Clarify behaviour of `?set_presence=unavailable` for /sync
6 years ago
Travis Ralston
adef7babfa
Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields
6 years ago
Travis Ralston
ad068bcd22
Fix the appservice directory visibility type parameter type
6 years ago
Travis Ralston
e9579a7840
The `rank` in search results is actually a floating point number
...
This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.
6 years ago
Erik Johnston
fc1fdc95af
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
Travis Ralston
6cdb463829
Merge pull request #1571 from turt2live/travis/general/number-to-int
...
Replace applicable types of 'number' to 'integer'
6 years ago
Travis Ralston
f9c7014a65
Merge pull request #1577 from turt2live/travis/c2s/search-filter
...
Specify the type of filter the search API expects
6 years ago
Travis Ralston
03065b0584
Merge pull request #1572 from turt2live/travis/c2s/sync-left-account-data
...
Add `account_data` to left rooms in /sync
6 years ago
Travis Ralston
f2332d242a
Add some SHOULDs and MUSTs to the user directory requirements
6 years ago
Travis Ralston
bb515d15a4
Clarify which collation to use for user directory searching
6 years ago
Travis Ralston
9527ce31f5
Merge pull request #1570 from turt2live/travis/c2s/sync-filtering
...
Update filtering API documentation
6 years ago
Travis Ralston
f01cfa2c7b
Add security definitions to hs->as endpoints
6 years ago
Travis Ralston
17e0ef4b91
Remove empty file and now-empty section from the appservice spec
...
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
6 years ago
Travis Ralston
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
6 years ago
Travis Ralston
87133d8505
Merge pull request #1574 from turt2live/travis/c2s/fix-directory-put
...
Clean up PUT /directory/room
6 years ago
Travis Ralston
a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
...
General improvements to the push rules module
6 years ago
Travis Ralston
97508d5dc5
Merge pull request #1554 from turt2live/travis/general/appservice-directories
...
Application service room directories (and other third party network things)
6 years ago
Travis Ralston
32ac81c588
Spelling
6 years ago
Travis Ralston
5fa6b49365
Specify the type of filter the search API expects
...
Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands
Fixes https://github.com/matrix-org/matrix-doc/issues/598
6 years ago
Travis Ralston
8069981252
Add federation /user/* endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
6 years ago
Travis Ralston
e60b44e27f
Clean up PUT /directory/room
...
Fixes https://github.com/matrix-org/matrix-doc/issues/933
The issue references two problems: a `roomInfo` and lack of a `room_id`. It appears the `room_id` has been fixed since reporting, however the `roomInfo` remained (and is now fixed).
6 years ago
Travis Ralston
55c0b968b5
Fix event schemas for /sync
...
This commit clarifies the required keys for each type of event that appears in sync, fixes the core event schema not declaring 'content' as required, and includes a mention that events may not have a room_id when appearing in /sync.
Fixes https://github.com/matrix-org/matrix-doc/issues/595
Fixes https://github.com/matrix-org/matrix-doc/issues/909
6 years ago
Travis Ralston
008ebb8c1a
Add `account_data` to left rooms in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
6 years ago
Travis Ralston
667fa082af
Replace applicable types of 'number' to 'integer'
...
`number` implies/represents a float where `integer` does not.
The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.
Fixes https://github.com/matrix-org/matrix-doc/issues/746
6 years ago
Travis Ralston
b68ed5d594
Define the default for the contains_url filter param
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1553
6 years ago
Travis Ralston
1cbcaba2c7
Clean up examples in filter.yaml
...
Indentation, excess examples.
6 years ago
Travis Ralston
26a7a341f0
Mark the filter_id in the response of POST /filter as required
6 years ago
Travis Ralston
97e3dd443b
Update room_event_filter.yaml to use the OpenAPI allOf definition
...
This is just maintenance.
6 years ago
Travis Ralston
7d08ef73d0
Fix naming of the Filter schemas
...
EventFilter !== Filter
Fixes https://github.com/matrix-org/matrix-doc/issues/1509
6 years ago
Travis Ralston
1bc0f63bfb
Clarify the homeserver's behaviour for user searching
...
The homeserver can implement its own algorithm, but is suggested to ensure the requesting user can reasonably see the other users.
The text is intentionally left vague for whether or not the API is local users only to give the homeserver some flexibility in this area.
General cleanup is also included in this commit.
Fixes https://github.com/matrix-org/matrix-doc/issues/1108
6 years ago
Travis Ralston
b4be11af42
Document POST /account/3pid/delete
...
Fixes https://github.com/matrix-org/matrix-doc/issues/985
Includes documentation for https://github.com/matrix-org/synapse/pull/3667
Raises https://github.com/matrix-org/matrix-doc/issues/1566
6 years ago
Travis Ralston
a803d9d077
Document `validated_at` and `added_at` on GET /3pid
...
Fixes https://github.com/matrix-org/matrix-doc/issues/661
6 years ago
Kitsune Ral
c879eb950f
client-server/openid.yaml: Fix a type'o
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Travis Ralston
dafea96621
Fix indentation and schema references in the identity service spec
6 years ago
Travis Ralston
4abd618147
Flag response fields in the Identity Service spec as required
6 years ago
Travis Ralston
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
6 years ago
Travis Ralston
2d43ff1234
Update third party network schemas
...
Some information was missed when this was reviewed. This commit adds some additional documentation for how these objects interact with each other.
6 years ago
Travis Ralston
9eda1a6971
Move the third party network API to it's own section
6 years ago
Travis Ralston
6a91ea9c85
Specify that application services receive events in the CSAPI format
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1269
This is also supposed to fix the 'age' problem, however that is a larger problem with the event schemas that is reserved for a future PR/commit.
Reference: https://github.com/matrix-org/matrix-doc/issues/1294
Reference: https://github.com/matrix-org/matrix-doc/issues/1524
6 years ago
Travis Ralston
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
Travis Ralston
7ec3cc4343
General improvements to the push rules module
...
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.
Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
6 years ago
Travis Ralston
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
6 years ago
Travis Ralston
6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
...
Clean up user and alias querying for application services
6 years ago
Travis Ralston
e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements
...
Add general clarity to the /createRoom endpoint
6 years ago
Travis Ralston
1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence
...
Document how presence EDUs work between servers
6 years ago
Travis Ralston
e500e2502a
Document the maximum value for depth
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1230
6 years ago
Travis Ralston
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
6 years ago
Travis Ralston
a320c58e42
A path parameter is obviously URL encoded
6 years ago
Travis Ralston
7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
...
General/small improvements to the application service API specification
6 years ago
Travis Ralston
8dc6f092ef
Define the type of the power_level_content_override field
6 years ago
Travis Ralston
7e6ca5fef8
Take out the room_alias response field
...
The argument is that this isn't really needed at this time.
6 years ago
Travis Ralston
1fd7c99461
Clarify that the creation event can have other keys in it
6 years ago
Travis Ralston
6c7a93d2f5
Move description about which preset to use when none is specified
6 years ago
Travis Ralston
7d14309b63
Move the power level event schema to where it was
6 years ago
Travis Ralston
c8ba2e098c
Wording improvements for appservices
6 years ago
Travis Ralston
8b65da1cf6
Don't try and be fancy about titles
6 years ago
Travis Ralston
e712466dca
Improve description for currently_active
6 years ago
Valentin Deniaud
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
6 years ago
Valentin Deniaud
8afc82c14b
fix /keys/claim request example
...
It didn't correspond to the example response.
6 years ago
Valentin Deniaud
ab3272045e
add missing v1 to m.olm in /keys/upload
6 years ago
Travis Ralston
60b8e72a67
Minor text changes to the query APIs; Keep OpenMarket copyright
...
The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header.
6 years ago
Travis Ralston
069a2f7481
Split the query user and room APIs out to their own files
6 years ago
Travis Ralston
5b5b4cfbed
Explicitly say how appservices should detect state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1014
6 years ago
Travis Ralston
a4015d5c27
Spelling
6 years ago
Travis Ralston
750d4f9fda
Rename the presence EDU files to be accurate to their types; Misc cleanup of titles
6 years ago
Hubert Chathi
f5dc0eaed2
document msisdn-related endpoints in IS ( #1507 )
...
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
6 years ago