Commit graph

1122 commits

Author SHA1 Message Date
Kitsune Ral 48af2e5b47 joining.yaml: put descriptions next to their properties
Fixing the problem described in https://github.com/matrix-org/matrix-doc/pull/2518#issuecomment-621684187
2020-05-28 14:17:01 +02:00
Kitsune Ral 040a91f42d api/: More cleanup in descriptions
(and a fix in one example).
2020-05-28 14:11:47 +02:00
Kitsune Ral 67a8176903 Clarify officially that we use multiple API files
This is not something endorsed by the OpenAPI spec, just our practice.
2020-05-28 13:55:37 +02:00
Kitsune Ral 6cfb94562e c2s: clean up $ref objects
* Most of the changes: align to the $ref object definition
  (https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3)
  that says that any attribute other than $ref be ignored.
* Remove extraneous leading ./ in $ref paths
* Fix an apparent typo in registration.yaml:
  /account/password/msisdn/requestToken used a file from ../identity/*
  instead of its c2s namesake.
2020-05-28 13:55:37 +02:00
Kitsune Ral c72d30513e c2s: Add required: true to request bodies 2020-05-25 19:08:17 +02:00
Kitsune Ral ff59fc1905 /keys/query: Add a title in the response
The device keys structure in queryKeys is not the same as the one
defined in device_keys.yaml (it adds things on top of it).

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2020-05-08 07:48:28 +02:00
Kitsune Ral 77783b8fc3 Remove extraneous quotes, fix a typo
filter.yaml: quotes under |- were taken literally.
notifications.yaml: it's a number in the example, not a string
2020-05-08 07:48:28 +02:00
Kitsune Ral 202bf8abb1 Cleanup summaries and descriptions 2020-04-29 20:15:06 +02:00
Patrick Cloke fc03f7faa6 Remove query_auth from the specification per MSC2451. 2020-03-24 12:42:15 -04:00
Aaron Axvig 4d808762da Change formatting from italics to code 2020-03-23 12:11:18 -04:00
Örjan Fors e151ba96ac Fix typo for upgrade
Signed-off-by: Örjan Fors <orion@29k.org>
2020-02-24 09:45:46 +01:00
Isaiah Inuwa 8e888b916c Fix spelling mistakes. 2020-01-18 09:09:42 -06:00
Travis Ralston f59aa563dd Add missing tags to push rules endpoints
Without the tags, the endpoints don't end up in the swagger. No changelog for this because it doesn't affect the spec itself.
2020-01-01 11:59:37 -07:00
Stuart Mumford c2ffef051f
Clarify description of user directory
Signed off by Stuart Mumford <stuart@cadair.com>
2019-12-05 09:27:37 -07:00
Travis Ralston 14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338
Add filter query param to /context
2019-11-06 10:53:21 -07:00
Travis Ralston 9f01850f7a Add some words about where the filter is applied 2019-11-06 10:43:11 -07:00
Travis Ralston a1e5a96cf8
Update api/client-server/event_context.yaml
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-11-06 10:42:08 -07:00
Travis Ralston 8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120
Recommend that clients don't preview URLs in encrypted rooms
2019-11-06 09:50:36 -07:00
Travis Ralston e59bb20dc3 Try to clarify the filter information on /context 2019-11-05 16:08:15 -07:00
Travis Ralston ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298
Clarify that submit_url is without authentication
2019-11-05 16:01:20 -07:00
Travis Ralston f012da17a1 Explain why e2e previews are bad 2019-11-05 16:00:55 -07:00
Travis Ralston a50e828509
Merge pull request #2342 from matrix-org/travis/spec/fix-1982
Clarify what format the `country` is on phone number inputs
2019-11-05 07:54:40 -07:00
Travis Ralston 3d954f93b5 Clarify that the room ID is the object key in /sync responses
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
2019-11-04 15:57:58 -07:00
Travis Ralston 021c056efc Add filter query param to /context
This was missed as part of lazy-loading.

Fixes https://github.com/matrix-org/matrix-doc/issues/2338
2019-11-04 15:55:20 -07:00
Travis Ralston b662a33081 Recommend that clients don't preview URLs in encrypted rooms
Any stronger of a recommendation would probably require a MSC due to the behaviour change. 

Fixes https://github.com/matrix-org/matrix-doc/issues/2120
2019-11-04 15:47:25 -07:00
Travis Ralston 284b15495b Clarify what format the country is on phone number inputs
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
2019-11-04 15:25:49 -07:00
Travis Ralston e95eafb2ba Clarify that submit_url is without authentication
The request is authorized by its parameters, not by an additional access token.

Fixes https://github.com/matrix-org/matrix-doc/issues/2298
2019-11-04 15:17:51 -07:00
Travis Ralston 2bca44a2e5 Remove extraneous backwards compatibility note 2019-10-28 14:28:48 -06:00
Travis Ralston f5f12a29e0 Spec MSC2290: 3PID binding split 2019-10-23 19:24:11 -06:00
Travis Ralston 3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server
Deprecate id_server and make it optional
2019-10-04 16:19:53 -06:00
Travis Ralston 48b8a95df6 Deprecate id_server and make it optional
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
2019-10-03 09:41:45 -06:00
Kitsune Ral 6b37bb1dd9 Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support 2019-10-03 11:06:27 +09:00
Travis Ralston 8d865ca53a Add s2s POST /publicRooms per MSC2197
See https://github.com/matrix-org/matrix-doc/pull/2197
2019-09-24 13:36:51 -06:00
Travis Ralston 2c88f02daa
Merge pull request #2287 from matrix-org/travis/spec/lookup-v2
Spec the v2 lookup API
2019-09-16 08:45:11 -06:00
Travis Ralston d813b8e12c Mention M_INVALID_PARAM 2019-09-10 09:35:37 -06:00
Travis Ralston 6cfd761204 Spec the v2 lookup API
Spec for [MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134)
2019-09-09 19:58:06 -06:00
Travis Ralston 642be6c677 Fix unbind wording 2019-09-06 13:06:16 -06:00
Travis Ralston 30a9de7e02 Merge branch 'master' into travis/spec/is-unbind 2019-09-06 13:05:19 -06:00
Travis Ralston a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms
Spec IS terms of service
2019-09-06 10:29:47 -06:00
Travis Ralston 1881a255c2 Clarify that id_access_token is optional for r0.5 2019-09-05 13:53:58 -06:00
Travis Ralston 185c564a13 Spec client-server IS unbind API
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140)

Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
2019-09-04 16:38:15 -06:00
Travis Ralston 2d784d93ef Merge branch 'master' into travis/spec/is-auth 2019-09-04 16:35:50 -06:00
Travis Ralston 001c51a740 /3pid/delete and /deactivate don't take an id_access_token 2019-09-03 15:09:59 -06:00
Travis Ralston 52e6868f50 Remove bind_* params on /register as per MSC2140
See https://github.com/matrix-org/matrix-doc/pull/2140
See https://github.com/matrix-org/matrix-doc/issues/2253
2019-09-03 15:03:41 -06:00
Travis Ralston afd5018494 Spec the terms of service handling for identity servers
Part of MSC2140

Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
2019-09-03 14:04:05 -06:00
Travis Ralston 0408373cf9 Litter the client-server API with id_access_token 2019-08-28 15:47:08 -06:00
Travis Ralston 4d0ea64121 Define authentication, ripping off the client-server API description 2019-08-28 15:46:58 -06:00
Travis Ralston e40d9e296d Split OpenID token info out verbatim 2019-08-28 15:46:58 -06:00
Travis Ralston ca4d9d8636 Deprecate the v1 IS API 2019-08-28 14:19:13 -06:00
Travis Ralston a47c5aeb42 v2-ify the v2 api
Note that ping and pubkey doesn't require auth - see MSC2140 for more information.
2019-08-28 14:17:51 -06:00