01cd41de68
Add GitHub Action to check spelling ( #3591 )
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
0fbc6bdab6
Definition of "Standard Identifier Format" ( #3171 )
...
Spec for https://github.com/matrix-org/matrix-doc/pull/2758
3 years ago
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.
3 years ago
ac98c8c08c
OpenAPI: Add missing `required` flag in `getRoomKeys` ( #3509 )
3 years ago
a8cf4d4a56
Open API: Changed RoomKeys to RoomKey ( #3500 )
3 years ago
a034d45e45
typos: Corrected typos in message_pagination.yaml ( #3495 )
3 years ago
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
3 years ago
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
3 years ago
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
3 years ago
f1a4a58755
Fix "invite_state" to "knock_state" ( #3428 )
3 years ago
525728971b
Fix two links on the CS API page
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
6bd7b6cbb5
Clarifications to pagination parameters for various APIs ( #3353 )
3 years ago
8a8db03a13
OpenAPI: include peekEvents
...
Disambiguate from getEvents by a trailing space in path (like inviteUser).
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
ddbbd76b32
Fix typo in /_matrix/client/r0/account/3pid/delete.
3 years ago
b231220bbd
Merge pull request #3337 from uhoreg/room_create_canonical_alias
...
room creation: create canonical alias event if alias specified
3 years ago
fbf4259a83
Merge pull request #3330 from lukaslihotzki/add-titles
...
OpenAPI: add titles
3 years ago
8536cd3e16
drop initial state check
3 years ago
5749325fc3
Merge pull request #3329 from lukaslihotzki/missing-tags
...
OpenAPI: improve tags
3 years ago
13f7df1379
OpenAPI: add titles
3 years ago
89089e8913
Merge pull request #3332 from lukaslihotzki/required-bodies
...
OpenAPI: require all bodies in cross_signing
3 years ago
39e70a2902
OpenAPI: split User data tag
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
ee92c94cfe
Mention that a canonical alias event should be created if alias specified
3 years ago
1a81a46865
OpenAPI: require all bodies in cross_signing
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
97ebe5aec2
OpenAPI: add missing tags
...
peekEvents remains untagged, because it is explicitly excluded.
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
e3070bcdda
OpenAPI: fix key_backup operation IDs
3 years ago
c58d423aba
OpenAPI: add auth property in uploadCrossSigningKeys
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
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>
3 years ago
cdcc24af11
Merge pull request #3238 from lukaslihotzki/required-bodies
...
OpenAPI: require all bodies in client-server
3 years ago
ad0ff78316
OpenAPI: require all bodies in client-server
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
c5631b30b8
sso_login_redirect: Fix a copy-pasted operationId
3 years ago
86b53be3d1
Add "knock" membership to /members endpoint ( #3254 )
3 years ago
6c46933fbc
Fix Typo
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
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>
3 years ago
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).
3 years ago
c11efb35fe
Merge pull request #3163 from matrix-org/travis/spec/msc2858-multisso
...
Describe social-sign-on (multiple SSO providers)
3 years ago
2c3d7b1682
Apply suggestions from code review
...
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
3 years ago
3683d334f7
Clarify render approach
3 years ago
3b2c0ff233
Spec device_id on whoami
...
Spec for https://github.com/matrix-org/matrix-doc/pull/2033
3 years ago
c124462747
Move brand registry out of structured data directory
...
Markdown is not structured data.
3 years ago
3b426846fe
Describe social-sign-on (multiple SSO providers)
...
Spec for [MSC2858](https://github.com/matrix-org/matrix-doc/pull/2858 )
3 years ago
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.
3 years ago
cee03d7625
Use the same domain for room ID and avatar URL.
3 years ago
3e03e7b17a
A few small fixes in /data and /content
3 years ago
873e8b30eb
Fix links in data
3 years ago
27f8867aa0
Change RST code formatting markup to Markdown
3 years ago
c7cf90abfa
Remove RST alert directives, replace with simple Markdown formatting
3 years ago
00c6a866e2
Move raw API and event schemas into /data directory
...
Historical note: this was originally a series of several commits, spread out
over several weeks. They have been squashed together to make `git annotate`
work properly.
The original commits were:
* 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory
* aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files
* 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one
* 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly
* 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too
* 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
3 years ago
Aaron Raimist