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
7 years ago
c879eb950f
client-server/openid.yaml: Fix a type'o
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
7 years ago
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
7 years ago
e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements
...
Add general clarity to the /createRoom endpoint
7 years ago
8dc6f092ef
Define the type of the power_level_content_override field
7 years ago
7e6ca5fef8
Take out the room_alias response field
...
The argument is that this isn't really needed at this time.
7 years ago
1fd7c99461
Clarify that the creation event can have other keys in it
7 years ago
6c7a93d2f5
Move description about which preset to use when none is specified
7 years ago
7d14309b63
Move the power level event schema to where it was
7 years ago
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
7 years ago
8afc82c14b
fix /keys/claim request example
...
It didn't correspond to the example response.
7 years ago
ab3272045e
add missing v1 to m.olm in /keys/upload
7 years ago
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
7 years ago
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
7 years ago
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
...
Document OpenID in the client-server and server-server APIs
7 years ago
5b30d33b89
Simpler language
7 years ago
c891e4a957
Require the push gateway URL to be of a specific path
7 years ago
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)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
7 years ago
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
7 years ago
de961fb7d6
Improve wording on push gateways
7 years ago
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
7 years ago
292d334509
document new login identifier object ( #1390 )
7 years ago
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)
7 years ago
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)
7 years ago
54a88eebf0
Merge pull request #1414 from matrix-org/anoa/third_party_cleanup
...
Clarification on third party fields
8 years ago
5f8967c074
Move TODO. field1, field2... -> fields...
8 years ago
a2e2ced03b
Add reverse-lookup examples.
8 years ago
d785ac78a3
Remove explode and replace with TODO, require auth on CS
8 years ago
53137a3c53
c/p bug, fix operationIds, move rst docs to md
8 years ago
273acb277c
Change fields to use new extended query array syntax
8 years ago
5ddf5374db
Missing comma
8 years ago
e4fd088fcc
Fix room tags spec
8 years ago
05fb94e195
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
8 years ago
d2b0b1bbda
Merge pull request #1379 from turt2live/travis/preset-guests
...
Document guest_access in /createRoom presets; Make presets a table
8 years ago
1829589d23
Convert 3pn errors to new definition
8 years ago
197c36c520
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
8 years ago
91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup
...
Thirdparty Entity Lookup API
8 years ago
291a4dfc76
Third party lookup module. Fix wording
8 years ago
6e3993effe
Merge remote-tracking branch 'matrix-org/master' into travis/preset-guests
8 years ago
84e07a0c10
Convert errors in presence.yaml
8 years ago
16125f16f5
Spec retry_after_ms on ratelimit errors
8 years ago
8b513b9f8e
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
8 years ago
8999887245
Path -> query params
8 years ago
9bde78ac28
$ref needs to be under a schema:
8 years ago
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
8 years ago
fbee83d5cf
Clarify some of the properties on the search result
...
Fixes https://github.com/matrix-org/matrix-doc/issues/773
8 years ago
d7a979da63
Merge remote-tracking branch 'matrix-org/master' into travis/all-the-auth
8 years ago
516000bdc3
Fix error reference in media repo
8 years ago
ab75fc4b20
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
8 years ago
e7a6ff1064
Merge branch 'master' into travis/spec-reason
8 years ago
Travis Ralston