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
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
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
Bruno Windels
8b28972a2d
PR feedback
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
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
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
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
b3d86f99b9
Add room summary 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
Andrew Morgan
3c62b90dfb
Add missing punctuation
6 years ago
Richard van der Hoff
14715468bb
Make thumbnail dimensions mandatory
...
Fixes #1883
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
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
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
...
remove references to presence lists
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
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
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
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
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
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
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
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
5da3072eef
Wording change ('may not' has a special meaning)
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
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
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
7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state
...
Document 403 error for sending state events
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
Hubert Chathi
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
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
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
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
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
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
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
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
e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements
...
Add general clarity to the /createRoom endpoint
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
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
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
Travis Ralston
8ac6cea58b
Merge pull request #1522 from turt2live/travis/c2s/http-push-gw-required-path
...
Require the push gateway URL to be of a specific path
6 years ago
Travis Ralston
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
...
Document OpenID in the client-server and server-server APIs
6 years ago
Travis Ralston
5b30d33b89
Simpler language
6 years ago
Travis Ralston
c891e4a957
Require the push gateway URL to be of a specific path
6 years ago
Travis Ralston
45c68e323a
Add general clarity to the /createRoom endpoint
...
This commit does a number of things:
* Minor formatting/alignment changes
* Document the room_alias response key. This could be deprecated now, or forfeited, if needed.
* Remove the guest_can_join parameter - it is not actually supported
* Document the previously undocumented power_level_content_override parameter
* Clarify that the room_id is required on the response
* More clearly spell out which events are created as part of the request
* Clarify how the room alias becomes the canonical alias
* Clarify how the `visibility` may be used to determine a default preset to apply
* Document the `m.federate` creation content parameter, adding an option for the homeserver to define a default value
References:
* Preset being inferred by the visibility: cd32c19a60/synapse/handlers/room.py (L172-L177)
* Power level content overrides:
* https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L198
* https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L335-L359
* Aliases becoming canonical: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L366-L370
* `m.federate` landing in the create event: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L311-L315
Fixes https://github.com/matrix-org/matrix-doc/issues/1243
Fixes https://github.com/matrix-org/matrix-doc/issues/1471
Inspired by https://github.com/matrix-org/matrix-doc/issues/1213
6 years ago
Travis Ralston
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
6 years ago
Travis Ralston
de961fb7d6
Improve wording on push gateways
6 years ago
Hubert Chathi
fcca80dad8
various minor fixes
...
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
6 years ago
Hubert Chathi
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
6 years ago
Travis Ralston
6ad71f785e
Improve documentation for pushers and push gateways
...
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format
Note: this does not attempt to document push rules, just pushers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
6 years ago
Hubert Chathi
292d334509
document new login identifier object ( #1390 )
6 years ago
Travis Ralston
8ffac01efe
Document OpenID in the client-server API
...
Part of https://github.com/matrix-org/matrix-doc/issues/857
Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
6 years ago
Travis Ralston
2ac80d38d7
Document the /publicRooms endpoint for federation
...
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476
The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.
The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
6 years ago
Andrew Morgan
54a88eebf0
Merge pull request #1414 from matrix-org/anoa/third_party_cleanup
...
Clarification on third party fields
6 years ago
user
5f8967c074
Move TODO. field1, field2... -> fields...
6 years ago
user
a2e2ced03b
Add reverse-lookup examples.
6 years ago
user
d785ac78a3
Remove explode and replace with TODO, require auth on CS
6 years ago
Andrew Morgan
53137a3c53
c/p bug, fix operationIds, move rst docs to md
6 years ago
Andrew Morgan
273acb277c
Change fields to use new extended query array syntax
6 years ago
David Baker
5ddf5374db
Missing comma
6 years ago
David Baker
e4fd088fcc
Fix room tags spec
6 years ago
Travis Ralston
05fb94e195
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
Travis Ralston
d2b0b1bbda
Merge pull request #1379 from turt2live/travis/preset-guests
...
Document guest_access in /createRoom presets; Make presets a table
6 years ago
Travis Ralston
1829589d23
Convert 3pn errors to new definition
6 years ago
Travis Ralston
197c36c520
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
Travis Ralston
91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup
...
Thirdparty Entity Lookup API
6 years ago
Andrew Morgan
291a4dfc76
Third party lookup module. Fix wording
6 years ago
Travis Ralston
6e3993effe
Merge remote-tracking branch 'matrix-org/master' into travis/preset-guests
6 years ago
Travis Ralston
84e07a0c10
Convert errors in presence.yaml
6 years ago
Travis Ralston
16125f16f5
Spec retry_after_ms on ratelimit errors
6 years ago
Travis Ralston
8b513b9f8e
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
Andrew Morgan
8999887245
Path -> query params
6 years ago
Andrew Morgan
9bde78ac28
$ref needs to be under a schema:
6 years ago
Andrew Morgan
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
6 years ago
Travis Ralston
fbee83d5cf
Clarify some of the properties on the search result
...
Fixes https://github.com/matrix-org/matrix-doc/issues/773
6 years ago
Travis Ralston
d7a979da63
Merge remote-tracking branch 'matrix-org/master' into travis/all-the-auth
6 years ago
Travis Ralston
516000bdc3
Fix error reference in media repo
6 years ago
Travis Ralston
ab75fc4b20
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
Travis Ralston
e7a6ff1064
Merge branch 'master' into travis/spec-reason
6 years ago
Travis Ralston
1722734a51
Merge pull request #1364 from turt2live/travis/server-name-join
...
Document the server_name query parameter on /join/{roomIdOrAlias}
6 years ago
Will Hunt
ff3c379339
Merge pull request #1189 from Half-Shot/hs/upload-limits
...
GET media/config 🎉
6 years ago
Will Hunt
77f4ac54aa
Wordy intro sentence for description
6 years ago
Will Hunt
2e6cc8045c
Better indent of description
6 years ago
Will Hunt
d5ce87e956
Split summary up into description and summary
6 years ago
Travis Ralston
bbf63d116c
Fix reference to error.yaml in forget room API
6 years ago
Travis Ralston
55c27d6212
Merge branch 'master' into travis/better-errors
6 years ago
Travis Ralston
4485b2f025
Merge branch 'master' into travis/server-name-join
6 years ago
Travis Ralston
c1c1f28c79
Merge branch 'master' into travis/dont-forget-to-leave
6 years ago
Travis Ralston
3935861445
Merge pull request #1380 from turt2live/travis/define-roomevent
...
Define RoomEvent on /rooms/{roomId}/messages
6 years ago
Travis Ralston
16860ddd22
De-quote
6 years ago
Andrew Morgan
4c38012122
I can spell
6 years ago
Andrew Morgan
e6218b56ab
Switch properties to schema
6 years ago
Andrew Morgan
a6dad76c01
Fix indentation
6 years ago
Andrew Morgan
cc3724b54a
fix indentation, error messages. add rest of PR
6 years ago
Kitsune Ral
dfdc5f9bef
search.yaml: Rename some titles to avoid confusion between request and response schemas
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
7 years ago
Travis Ralston
436b410698
Document the error code when someone tries to forget a room they are in
7 years ago
Travis Ralston
9b1f3a1f47
Document guest_access in /createRoom presets; Make presets a table
...
Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear.
Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description.
This commit also updates the documentation to reference `preset`, not `presets` given the param is singular.
Fixes https://github.com/matrix-org/matrix-doc/issues/881
7 years ago
Hubert Chathi
ce1e2c0904
incorporate feedback from reviewers
7 years ago
Travis Ralston
9e796192e4
Document that clients must leave before forgetting rooms
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1011
7 years ago