Commit Graph

139 Commits (45b6aaf07ae119a0e284192d6de8a13cf668d06f)

Author SHA1 Message Date
Kévin Commaille 45b6aaf07a
Upgrade Swagger data to OpenAPI 3.1 (#1310)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
Kévin Commaille 089d209047
Mark the appservice ping response `duration_ms` field as required (#1541)
* Mark the appservice ping response duration_ms field as required

As intended in MSC2659.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
Travis Ralston db0fd30744 Fix stray localhost link 1 year ago
Tulir Asokan 9dd9639dd7
Add spec for MSC2659: application service ping endpoint (#1516) 1 year ago
Travis Ralston 6496d374d2
Specify MSC3882: Using an existing session to log in another (#1530)
* Specify MSC3882: Using an existing session to log in another

MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3882

* Changelog entries

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

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Link to endpoint

* Copy/paste `auth` dict definition

* Move get_token API to the correct version prefix (v1, not v3)

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

---------

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
1 year ago
Nick Mills-Barrett 4fabef1c97
Add `allow_redirect` query parameter to relevant media endpoints (#1529)
* Add `allow_redirect` query parameter to relevant media endpoints

* Add added in version flag to `allow_redirect` params

* Add 307/308 responses to media endpoints

* Add changelogs
1 year ago
Patrick Cloke 466acdfc46
Update spec for MSC3952: intentional mentions (#1508)
See MSC3952.
1 year ago
Hubert Chathi dc5d95c242
Clarify signatures upload endpoint (#1495)
* clarify signatures upload endpoint

* add changelog
1 year ago
Patrick Cloke e1dc5f8f53
Remove the `dont_notify` and `coalesce` push rule actions. (#1501)
* Remove the `dont_notify` and `coalesce` push rule actions.

Per MSC3987, these should both be considered no-ops.

* Remove obsolete dont_notify from default rules.

* Remove obsolete dont_notify from examples.
1 year ago
Richard van der Hoff 283c5877fe
Spec asynchronous uploads (#1499)
Spec for matrix-org/matrix-spec-proposals#2246
1 year ago
Richard van der Hoff 1f729eef60
"MXC URI" -> "`mxc://` URI" (#1500)
* "MXC URI" -> "`mxc://` URI"

We're a bit inconsistent with this currently, and IMHO "`mxc://` URI" is more
explicit.

* Update content/client-server-api/modules/content_repo.md

Co-authored-by: Hubert Chathi <hubertc@matrix.org>

* more MXCs

---------

Co-authored-by: Hubert Chathi <hubertc@matrix.org>
1 year ago
Richard van der Hoff 715f6a301d
Spec annotations (#1475) 1 year ago
Richard van der Hoff a225025cab
Remove fictitious `token` parameter on `/keys/query` (#1485) 1 year ago
Patrick Cloke d222fc60d6
Document MSC3758, MSC3966, MSC3873, and MSC3980. (#1464)
* Add information on MSC3758: event_property_is.

* Add information on MSC3966: event_property_contains.

* Add information on MSC3873 dotted-path escape rules.

* Newsfragment

* Update sync filter with ref to appendix.

* Escape example key.

* Fix typos.

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

* Fix links.

* Clarify the appendix a bit.

* Clarify support values.

* Add MSC3980 to changelog.

---------

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
1 year ago
Kim Brose a21b23dda8
Fix typo in registration.yaml (#1474) 1 year ago
Richard van der Hoff d26794ee90
Clarify terminology around aggregations (#1424)
I've done my best to remove the word "bundle", because I feel like it causes
more confusion than it provides. Instead I have favoured "aggregated child
events" which I think is clearer.

Some general clarification around these parts of the spec.
1 year ago
Stuart Mumford 09e2250a8d
Spec implicit filter event limit (#1463)
Signed-off-by: Stuart Mumford <stuart@cadair.com>
1 year ago
Patrick Cloke afae1083aa
Clarify what key content-specific rules match against. (#1441) 1 year ago
Alexey Rusakov b441b19cc3
More cleanup before upgrading to OpenAPI 3.1 (#1455)
* `cross_signing_key.yaml`: the parameter documentation already restricts the number of properties
 * `receipts.yaml`: use `maxProperties: 0` to say the object is empty (the comment is still there but is not really needed any more)
 
Signed-off-by: Alexey Rusakov <Kitsune.Ral@users.sf.net>
1 year ago
Andrew Morgan c0955a6aee
Add a hyphen between third and party when used as an adjective (#1447) 1 year ago
Alexey Rusakov 9ebcf5f257
OpenAPI compliance: avoid $ref siblings (#1457)
This strives to fix all remaining cases where additional attributes
(most often 'description' but not only) are provided next to $ref
by wrapping $ref in allOf; and also drops allOf in a couple of places
where $ref is the only element under it.
1 year ago
Kévin Commaille d55af02738
Add links to the spec for the definition of 3PID `medium` (#1417)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
dylhack.dev f06ffc8176
replace "<content>" with "content" (#1370)
* replace "<content>" with "content"

This parameter that's part of the content-repo openapi spec causes generators to mess up

* added changelogs

* Update changelogs/internal/newsfragments/1370.clarification

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

Co-authored-by: Travis Ralston <travpc@gmail.com>
1 year ago
Hubert Chathi 94465fe93b
Add spec for getting events by timestamp (#1366) 2 years ago
Richard van der Hoff 7bd48ca9c7
Stop autogenerating examples where we already have one (#1384)
If an object definition already has an example, we shouldn't try to extend that
definition by adding examples derived from the individual properties. Doing so
is confusing, and there is no way to inhibit it when it is not desired. It's
also not what the RapiDoc viewere does, so we end up with examples being
inconsistent.
2 years ago
Kévin Commaille 7af45a36fc
Fix `read_markers`
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Kévin Commaille 6ffc5e6ed0
Fix `and` -> `an`
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Kévin Commaille 8d4a3bb912
Clarify what fields are required when deleting a pusher (#1321)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Sumner Evans 84fbb611db
Clarify that /context always returns 'event' even if limit is zero (#1239)
Signed-off-by: Sumner Evans <me@sumnerevans.com>
2 years ago
Hubert Chathi 2fcc92c2fb
improve documentation of ephemeral events (#1284) 2 years ago
David Baker 312a0e9b05 Add example read receipt to sync example
Fixes https://github.com/matrix-org/matrix-spec/issues/120
2 years ago
Richard van der Hoff b9952f1a74
Merge pull request #1329 from matrix-org/rav/htmltest
Add link checker to CI
2 years ago
Richard van der Hoff 44c7eb5b88
Merge pull request #1330 from matrix-org/rav/fix_dead_links
Fix broken links
2 years ago
BramvdnHeuvel 6879f96c90
Require refresh_token on refresh token endpoint (#1323)
Signed-off-by: Bram van den Heuvel matrix-spec@noordstar.me
2 years ago
Kévin Commaille 8526e4fcd9
Clarify the behavior of `PUT /pushrules/{scope}/{kind}/{ruleId}` (#1319)
This is based on the behavior of Synapse and Dendrite. Conduit's implementation is already non-compliant in regards to what was already defined in the spec.

Closes #645.
Related to #647 (probably closes it too, unless we want to be more explicit somewhere about what can be changed on default push rules).

Related PR in ruma that would allow to fix Conduit's implementation: ruma/ruma#1364

Signed-off-by: Kévin Commaille zecakeh@tedomum.fr
2 years ago
Richard van der Hoff 9e8360560b Uniquify some links
The link checker doesn't understand that we dynamically re-assign element IDs
at load time, so was failing for a few links that were technically valid
(though presumably still broken for any client not using JS).

Work around this by manually setting a few anchors, linking to other nearby
bits of text, or just changing heading titles.
2 years ago
Richard van der Hoff 6cbb88f9df Fix broken links
A bunch of broken links I found
2 years ago
David Robertson ad99be4ad7
Define a 400 response from {PUT,GET,DELETE} `/directory/rooms/{roomAlias}` (#1286)
* Define a 400 response from {PUT,GET,DELETE} `/directory/rooms/{roomAlias}`

* Changelog

* Adjust changelog

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

* Refer to appendices

Co-authored-by: Travis Ralston <travpc@gmail.com>
2 years ago
Kévin Commaille d3d4afdbfd
Receipts: Add `thread_id` to the `/receipt` endpoint (#1261)
* Receipts: Add thread_id to the /receipt endpoint

It seems to have been omitted in #1255

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Fix missing backtick

* Apply suggestion for error description

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

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2 years ago
Travis Ralston 227757d499
Threads: Read receipts & notifications (#1255)
* Spec MSC3771: Threaded read receipts

Note: this builds on a (as of writing) non-existent "threading" section, which is part of a different commit.

* Spec MSC3773: Threaded notifications

* changelog

* Various clarifications per review
2 years ago
Travis Ralston 25dda1eadb
Threads: The base (#1254)
* Spec MSC3440: Threading (just the base)

Other threading MSCs to follow

* Spec MSC3856: Threads list API

* Spec MSC3715:  Add`dir` to `/relations`

* changelog

* Apply suggestions from code review

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

* Update changelogs/client_server/newsfragments/1254.feature

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2 years ago
Travis Ralston 6c6c602845
Clarify that refreshed access tokens don't invalidate the scope of txnid (#1236) 2 years ago
Michael Telatynski 7ab3aecf29
Update profile.yaml (#1238)
* Update profile.yaml

* Create 1238.clarification

* Update changelogs/client_server/newsfragments/1238.clarification

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>
2 years ago
Andrew Morgan e7e376142e
Fix typos in the spec related to account data (#1243) 2 years ago
Travis Ralston e406bd94f6
Spec MSC2285: Private read receipts (#1216)
* Convert `m.receipt.yaml` to traditional YAML

* Spec MSC2285 (private read receipts)

* Add some obvious copyright headers

* Add changelog entries

* Appease the linter

Apparently it hates it when you do this.

* Allow m.fully_read on /receipts

* Apply suggestions from code review

Co-authored-by: Matthew Hodgson <matthew@matrix.org>

Co-authored-by: Matthew Hodgson <matthew@matrix.org>
2 years ago
Will Hunt 8df0cfeae0
s/room/rooms (#1215)
* s/room/rooms

Fixes #979

* Create 1215.clarification
2 years ago
Andrew Morgan 5572d33453
Require `access_token`, `device_id` and `user_id` fields in `/login` response (#1210) 2 years ago
Travis Ralston b14759a27b
Add `room_types` and `room_type` to `/publicRooms` (#1199)
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3827
Incorporates https://github.com/matrix-org/matrix-spec-proposals/pull/3858
2 years ago
Richard van der Hoff ea42cd3c7b
Move various e2e defintions out to yaml files (#1166)
We have code to generate tables, which we should use in the e2e section.
2 years ago
David Robertson f9028acf8e
Describe return codes for account data endpoints + minor clarifications (#1155) 2 years ago