wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
6172 commits 4 branches 0 tags 17 MiB
Commit graph

51 commits

Author SHA1 Message Date
Travis Ralston
26e0765159
Add guest changes to spec: MSC3069 and MSC3419 (#3605) 
* Add MSC3069 support

https://github.com/matrix-org/matrix-doc/pull/3069

* Add MSC3419 support

https://github.com/matrix-org/matrix-doc/pull/3419

* Normalize and fix guest access endpoints list

* Changelogs
 2022-01-04 20:29:40 -07:00
Travis Ralston
e4057072bd
Add registration token UIA type (#3616) 
* Add registration token UIA type

MSC: https://github.com/matrix-org/matrix-doc/pull/3231

**Note**: This introduces the endpoint as v1 rather than r0 given the global versioning changes landed between the acceptance of the MSC and now.

* Fix swagger

* Changelogs

* Update data/api/client-server/registration_tokens.yaml

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2022-01-04 20:27:58 -07:00
Travis Ralston
1e9dd4d22e
Avoid use of the word "clobber" (#3611) 
* Avoid use of the word "clobber"

Fixes https://github.com/matrix-org/matrix-doc/issues/1328

* changelog
 2021-12-30 22:07:45 -07:00
Dan Callahan
48d8f7202d
Add HTTP 403 to possible profile responses (#3530) 
* Add HTTP 403 to possible profile responses

Some servers may not allow profile lookup over federation, and thus
respond to GET /_matrix/client/v3/profile/{userId} with an HTTP 403.

For example, Synapse can be configured to behave in this way by setting:

    allow_profile_lookup_over_federation=false

Thus, this behavior already exists in the wild, and may cause issues for
clients such as https://github.com/vector-im/element-web/issues/17269.

Synapse could alter its behavior and return an HTTP 404 in these cases,
but amending the Spec seems preferable to align with extant behavior.
Further, allowing HTTP 403 gives clients more specific information as to
why a request has failed, enabling more precise error handling.

Signed-off-by: Dan Callahan <danc@element.io>

* Update changelogs/client_server/newsfragments/3530.clarification

Co-authored-by: Travis Ralston <travpc@gmail.com>

* Annotate misc data about error

Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Travis Ralston <travisr@matrix.org>
 2021-12-29 11:30:32 -07:00
Aaron Raimist
01cd41de68
Add GitHub Action to check spelling (#3591) 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2021-12-28 09:17:49 -07:00
Travis Ralston
0fbc6bdab6
Definition of "Standard Identifier Format" (#3171) 
Spec for https://github.com/matrix-org/matrix-doc/pull/2758
 2021-12-15 11:38:29 +00:00
Richard van der Hoff
83b24dd54d
Remove definition of Event for /notifications (#3525) 
The documentation for the `/notifications` API had its own special definition
of what an Event was, which was used nowhere else.

The common definition isn't perfect, but it *is* common, so it gives us a
better starting place for improvement.
 2021-12-02 17:23:09 +00:00
Ankur
ac98c8c08c
OpenAPI: Add missing required flag in getRoomKeys (#3509) 2021-11-22 13:23:24 -05:00
Ankur
a8cf4d4a56
Open API: Changed RoomKeys to RoomKey (#3500) 2021-11-16 14:39:55 -05:00
Ankur
a034d45e45
typos: Corrected typos in message_pagination.yaml (#3495) 2021-11-15 15:29:07 -05:00
Travis Ralston
5be0df02c5
Start annotating which version of the spec added a thing (#3425) 
* Introduce a new "added-in" template and use it on endpoints

* Use "added-in" on schema properties too

* Annotate sections of the spec with their added versions

* Demo of "added-in" on a room version (to be fleshed out)

* Use clearer versioning semantics

* Update and fix validator for Swagger custom properties

* Fix docs
 2021-10-14 13:23:04 -06:00
Travis Ralston
95d850c418
Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 
* Blind find & replace all on client major version -> v3

* Fix up bad replacements

* Fix anchors for r0->v3

* Changelog
 2021-10-12 11:07:01 -06:00
Travis Ralston
2d98cd3084
Describe new global specification versioning (#3420) 
* Update versioning specification for Matrix

As per [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844)

* Mention vX versioning in /versions

* Changelog
 2021-10-12 11:06:51 -06:00
Andrew Fargo
f1a4a58755
Fix "invite_state" to "knock_state" (#3428) 2021-10-05 23:11:40 -06:00
Aaron Raimist
525728971b Fix two links on the CS API page 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2021-08-27 19:17:18 +01:00
Richard van der Hoff
6bd7b6cbb5 Clarifications to pagination parameters for various APIs (#3353) 2021-08-27 19:17:18 +01:00
Lukas Lihotzki
8a8db03a13 OpenAPI: include peekEvents 
Disambiguate from getEvents by a trailing space in path (like inviteUser).

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Denis Kasak
ddbbd76b32 Fix typo in /_matrix/client/r0/account/3pid/delete. 2021-08-27 19:17:17 +01:00
Hubert Chathi
b231220bbd Merge pull request #3337 from uhoreg/room_create_canonical_alias 
room creation: create canonical alias event if alias specified
 2021-08-27 19:17:17 +01:00
Alexey Rusakov
fbf4259a83 Merge pull request #3330 from lukaslihotzki/add-titles 
OpenAPI: add titles
 2021-08-27 19:17:17 +01:00
Hubert Chathi
8536cd3e16 drop initial state check 2021-08-27 19:17:17 +01:00
Alexey Rusakov
5749325fc3 Merge pull request #3329 from lukaslihotzki/missing-tags 
OpenAPI: improve tags
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
13f7df1379 OpenAPI: add titles 2021-08-27 19:17:17 +01:00
Hubert Chathi
89089e8913 Merge pull request #3332 from lukaslihotzki/required-bodies 
OpenAPI: require all bodies in cross_signing
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
39e70a2902 OpenAPI: split User data tag 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Hubert Chathi
ee92c94cfe Mention that a canonical alias event should be created if alias specified 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
1a81a46865 OpenAPI: require all bodies in cross_signing 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
97ebe5aec2 OpenAPI: add missing tags 
peekEvents remains untagged, because it is explicitly excluded.

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
e3070bcdda OpenAPI: fix key_backup operation IDs 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
c58d423aba OpenAPI: add auth property in uploadCrossSigningKeys 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
91b232df48 OpenAPI: use uri format 
In avatar_url, pusher url, wellknown base_url, getUrlPreview, and submit_url.

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Travis Ralston
cdcc24af11 Merge pull request #3238 from lukaslihotzki/required-bodies 
OpenAPI: require all bodies in client-server
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki
ad0ff78316 OpenAPI: require all bodies in client-server 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Alexey Rusakov
c5631b30b8 sso_login_redirect: Fix a copy-pasted operationId 2021-08-27 19:17:17 +01:00
Christian Paul
86b53be3d1 Add "knock" membership to /members endpoint (#3254) 2021-08-27 19:17:15 +01:00
Lukas Lihotzki
6c46933fbc Fix Typo 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:14 +01:00
Lukas Lihotzki
2fa7b59e1a OpenAPI: fix tags of add3PID 
The tag needs to be set to include add3PID in scripts/swagger/api-docs.json.

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:14 +01:00
Andrew Morgan
ad93aa6546 Update client_secret examples so that they are valid (#2985) 
The regex of allowed characters for a `client_secret` parameter is `[0-9a-zA-Z.=_-]`.

This PR updates the `client_secret` spec examples, which currently include an invalid character (an apostrophe).
 2021-08-27 19:17:13 +01:00
Travis Ralston
c11efb35fe Merge pull request #3163 from matrix-org/travis/spec/msc2858-multisso 
Describe social-sign-on (multiple SSO providers)
 2021-08-27 19:17:13 +01:00
Travis Ralston
2c3d7b1682 Apply suggestions from code review 
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2021-08-27 19:17:12 +01:00
Travis Ralston
3683d334f7 Clarify render approach 2021-08-27 19:17:12 +01:00
Travis Ralston
3b2c0ff233 Spec device_id on whoami 
Spec for https://github.com/matrix-org/matrix-doc/pull/2033
 2021-08-27 19:17:12 +01:00
Travis Ralston
c124462747 Move brand registry out of structured data directory 
Markdown is not structured data.
 2021-08-27 19:17:12 +01:00
Travis Ralston
3b426846fe Describe social-sign-on (multiple SSO providers) 
Spec for [MSC2858](https://github.com/matrix-org/matrix-doc/pull/2858)
 2021-08-27 19:17:12 +01:00
Travis Ralston
fa6cc8a1ff Add knocking to the spec 
Spec for https://github.com/matrix-org/matrix-doc/pull/2998
Spec for https://github.com/matrix-org/matrix-doc/pull/2403

This deliberately does not help towards fixing https://github.com/matrix-org/matrix-doc/issues/3153 in order to remain consistent with prior room versions, and to keep the diff smaller on this change. A future change will address room version legibility.
 2021-08-27 19:17:12 +01:00
Patrick Cloke
cee03d7625 Use the same domain for room ID and avatar URL. 2021-08-27 19:17:10 +01:00
Will
3e03e7b17a A few small fixes in /data and /content 2021-08-27 19:16:42 +01:00
Will
873e8b30eb Fix links in data 2021-08-27 19:16:42 +01:00
Will
27f8867aa0 Change RST code formatting markup to Markdown 2021-08-27 19:16:42 +01:00
Will
c7cf90abfa Remove RST alert directives, replace with simple Markdown formatting 2021-08-27 19:16:42 +01:00