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
Travis Ralston
ebca4c7d86
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
6 years ago
Travis Ralston
21dc6f823a
Merge pull request #1484 from turt2live/travis/s2s/read-receipts
...
Document how read receipts work over federation
6 years ago
Travis Ralston
c492fe43b5
Add strict typing to the m.receipt EDU; Fix description of event_ids
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
96896fe5d6
Add a strict type the m.typing EDU
6 years ago
Travis Ralston
a53fa9300d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
6 years ago
Travis Ralston
766402a702
Use strict types for the presence EDUs
6 years ago
Travis Ralston
549a25cad9
Add a mention about how currently_active works
...
Reference: d69decd5c7/synapse/handlers/presence.py (L66-L68)
6 years ago
Travis Ralston
e7aed3da26
Remove poll/unpoll from presence
6 years ago
Travis Ralston
49ec0a36a8
Merge pull request #1481 from turt2live/travis/s2s/authentication
...
Define authorization requirements on federation swagger APIs
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
2aa0e7b00f
Merge pull request #1483 from turt2live/travis/s2s/typing
...
Document how typing notifications work over federation
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
de961fb7d6
Improve wording on push gateways
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
Kitsune Ral
b41eb26124
Document OpenAPI extension
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Hubert Chathi
cd4fed509c
convert IS endpoints to Swagger ( #1427 )
6 years ago
Hubert Chathi
292d334509
document new login identifier object ( #1390 )
6 years ago
Travis Ralston
25c77ab2d0
Define authorization requirements on federation swagger APIs
6 years ago
Travis Ralston
56dbeeb22a
Merge pull request #1469 from turt2live/travis/s2s/backfill
...
Improve documentation for backfilling rooms
6 years ago
Travis Ralston
721be47eb1
Describe how get_missing_events actually works
...
The original text wasn't far off, except for being wrong about what the fields actually do. This commit also adds a bit of clarity for how the server is expected to behave.
6 years ago
Travis Ralston
0a7e670715
Document how typing notifications work over federation
...
Relevant synapse code: d69decd5c7/synapse/handlers/typing.py (L221-L230)
6 years ago
Travis Ralston
e03bfbc47b
Document how read receipts work over federation
...
Federation format: d69decd5c7/synapse/handlers/receipts.py (L153-L166)
Population of the fields that the above uses to construct the EDU: d69decd5c7/synapse/handlers/receipts.py (L48-L56)
6 years ago
Travis Ralston
05a2427c73
Document how presence EDUs work between servers
...
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
6 years ago