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

267 commits

Author SHA1 Message Date
Ankur
a8cf4d4a56
Open API: Changed RoomKeys to RoomKey (#3500) 2021-11-16 14:39:55 -05:00
Will Hunt
51d8560da9
Explicitly link to geo URI spec (#3492) 
* Explicitly link to geo URI spec

* move RFC location

Co-authored-by: Travis Ralston <travisr@matrix.org>

* Create 3492.clarification

Co-authored-by: Travis Ralston <travisr@matrix.org>
 2021-11-15 15:58:39 -07:00
Ankur
a034d45e45
typos: Corrected typos in message_pagination.yaml (#3495) 2021-11-15 15:29:07 -05:00
Hubert Chathi
033038917d
remove extra type property (#3482) 2021-11-10 13:46:24 -05:00
Travis Ralston
5ea6d5610f
Update identity server spec to use global versioning (#3459) 
* Update identity server spec to use global versioning

* changelog
 2021-10-26 15:47:40 -06: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
649fc2bdd2
Move room version spec to /rooms (#3423) 
* Cut/paste room version spec to its own page

* Move grammar to bottom + add feature matrix

The version grammar is not as interesting as the actual room versions, so this moves that whole section to the bottom.

* Fix all links to room versions
 2021-10-12 14:47:03 -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
Neil Alexander
af0ebc7414 /_matrix/federation/v1/user/devices/{userId}: Rename self_signing_keys to self_signing_key (#3312) 
Apparently, in response to a /_matrix/federation/v1/user/devices/{userId} request, Synapse actually returns a key called "self_signing_key" instead of "self_signing_keys".
 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
Will Hunt
2794fc8e29 Explicitly call replacement_room a room ID 
Fixes https://github.com/matrix-org/matrix-doc/issues/3232
 2021-08-27 19:17:14 +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
466911b253 Merge pull request #3170 from matrix-org/travis/spec/msc2713-rm-v1-id 
Remove v1 identity service API
 2021-08-27 19:17:13 +01:00
Travis Ralston
3d217e0de0 Merge pull request #3101 from matrix-org/travis/spec/MSC2320-identity-versions 
Add identity service versions API
 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
fb3dde1c2c Merge pull request #3167 from matrix-org/travis/spec/msc2265-lower-3pid 
Specify that email handling converts to lowercase first
 2021-08-27 19:17:13 +01:00
Travis Ralston
c1d1f88a55 Update data/api/identity/versions.yaml 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2021-08-27 19:17:12 +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
37c3a3f855 Remove v1 identity service API 
Spec for https://github.com/matrix-org/matrix-doc/pull/2713
 2021-08-27 19:17:12 +01:00
Travis Ralston
57f609cf1b Typo fixes 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
457f3995af Merge pull request #3154 from matrix-org/travis/spec/knock-knock-whos-there 
Add knocking to the spec
 2021-08-27 19:17:12 +01:00
Travis Ralston
fc6aa30000 Merge branch 'master' into travis/spec/MSC2320-identity-versions 2021-08-27 19:17:12 +01:00
Travis Ralston
7cef7d0fcf Specify that email handling converts to lowercase first 
Spec for https://github.com/matrix-org/matrix-doc/pull/2265
 2021-08-27 19:17:12 +01:00
Travis Ralston
be86e638c5 Add identity service versions API 
Specs [MSC2320](https://github.com/matrix-org/matrix-doc/pull/2320)
Built upon https://github.com/matrix-org/matrix-doc/pull/3094
 2021-08-27 19:17:12 +01:00