Commit Graph

606 Commits (312799ae78a27112077753db9782e9193e12e2a7)

Author SHA1 Message Date
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 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
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