Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-18 21:33:42 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
6551 commits 28 branches 42 tags 33 MiB
Commit graph

930 commits

Author SHA1 Message Date
Hubert Chathi 94465fe93b
Add spec for getting events by timestamp (#1366) 2022-12-21 14:05:28 -05:00
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.
 2022-12-21 16:24:11 +00:00
Richard van der Hoff 966f3c443a
Fix edu_type on EDU examples (#1383) 
The top-level `example` in `edu.yaml` was overriding the individual examples
for `edu_type`. Let's fix that by getting rid of the example in `edu.yaml`.

Fixes https://github.com/matrix-org/matrix-spec/issues/805
 2022-12-21 16:23:50 +00:00
Kim Brose 05d2bc4c95
move login API definitions to the right heading (#1382) 
* move login API definitions to the right heading

regressed from https://github.com/matrix-org/matrix-spec-proposals/pull/3324

* Create 1382.clarification
 2022-12-19 15:47:00 -07:00
Richard van der Hoff f386c903c0
Clarify that CNAMEs are permissible for server names (#1376) 
Fixes https://github.com/matrix-org/matrix-spec/issues/606.
 2022-12-14 10:53:50 +00:00
Travis Ralston 8a555fb411
Add some safety to the proposals script (#1368) 
* Add some safety to the proposals script

for if github's api explodes, forgets the header, or we are rate limited or something.

* changelog
 2022-12-08 12:41:55 -07:00
Richard van der Hoff 9555cbe5a9
Fix incorrect default "Invite level" (#1371) 2022-12-08 10:41:00 +00:00
Kévin Commaille 2e789736cc
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-28 13:06:34 +01:00
Johannes Becker e481fd011a
Add link to the unstable spec to the README (#1357) 2022-11-24 11:09:05 +00:00
Kévin Commaille 8d4a3bb912
Clarify what fields are required when deleting a pusher (#1321) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-22 17:12:13 +00:00
Sumner Evans 84fbb611db
Clarify that /context always returns 'event' even if limit is zero (#1239) 
Signed-off-by: Sumner Evans <me@sumnerevans.com>
 2022-11-22 17:08:46 +00:00
Johannes Becker 3f3b5c39f0
Remove duplicated "Note:" from m.room.power_levels (#1355) 
Remove duplicated "Note:"

Signed-off-by: Johannes Becker <j.becker@famedly.com>
 2022-11-22 16:57:38 +00:00
David Robertson 07442876ce
Improve presentation of push rules kinds and actions (#1348) 2022-11-22 16:01:23 +00:00
Kévin Commaille 4534124742
Include examples inline instead of using a reference for invite endpoint definitions (#1349) 
The OpenAPI 3 spec doesn't allow building examples by composition.
Either the whole example must be a reference, or it has to be included.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-22 15:56:39 +00:00
Patrick Cloke eeb43043ad
Add standard error responses (MSC3743). (#1347) 2022-11-22 15:51:29 +00:00
Kévin Commaille dfc8a2e184
Fix POST _matrix/federation/v1/user/keys/claim response schema (#1351) 
The syntax was not compliant with the Swagger spec.
It also lacked one level of nesting.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-22 15:50:28 +00:00
Johannes Becker b2c4abf567
Clarify the power levels integer range (#1169) 
Signed-off-by: Johannes Becker <j.becker@famedly.com>
 2022-11-22 15:45:30 +00:00
Kim Brose 8830314401
Create 1353.clarification 2022-11-18 14:33:52 +01:00
Travis Ralston 5f2fac89af Matrix 1.5 2022-11-17 08:22:20 -07:00
Hubert Chathi 684ead8ab6
Merge pull request #1294 from uhoreg/rhul_clarifications 
add some e2ee clarifications
 2022-11-17 09:21:51 -05:00
Hubert Chathi 2fcc92c2fb
improve documentation of ephemeral events (#1284) 2022-11-17 07:53:15 +00:00
Hubert Chathi 64922771d4
Clarify that verifications without a request only happens over to-device (#1345) 2022-11-17 07:27:40 +00:00
Richard van der Hoff 1e393fbf92
Improve error messages emitted by resolve-additional-types (#1303) 
I forgot to set the `items` on an array definition, and got an extremely
opaque error. Hopefully this will improve the lives of anyone who makes a
similar mistake in future.
 2022-11-17 07:23:12 +00:00
Andrew Morgan cb2d5653ee
Add Event Replacements, Threading and Reference Relations modules to module summary table (#1344) 2022-11-17 00:07:04 +00:00
Andrew Morgan b5005e64f7
Document that non-spec changes should get an 'internal' changelog entry (#1342) 2022-11-16 13:44:55 +00:00
Richard van der Hoff f0246a5f12
Disable RSS for spec (#1346) 
This should really fix #1336
 2022-11-16 13:20:06 +00:00
Richard van der Hoff 3c9139bd5d
Unpack spec into right place for htmltest (#1338) 
Hopefully, fixes https://github.com/matrix-org/matrix-spec/issues/1336
 2022-11-15 23:30:17 +00:00
Richard van der Hoff 08fde5f257
Generate unstable changelogs using towncrier (#1340) 
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.

This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.

Fixes #908.
 2022-11-15 23:26:55 +00:00
David Baker 678f8b96f0
Merge pull request #1341 from matrix-org/dbkr/add_read_receipt_example 
Add example read receipt to sync example
 2022-11-15 20:47:18 +00:00
David Baker d620ff7a7c
Better newsfragment 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2022-11-15 20:24:18 +00:00
Richard van der Hoff bc15d4f9bc
Make definition anchors more unique (#1339) 
Stick a `definition-` on the front of the autogenerated anchors for definition
blocks.

This solves a problem where, for example,
https://spec.matrix.org/unstable/application-service-api/#registration could
refer to either the "Registration" section or the `Registration` definition
therein.

(These anchors are relatively recent: they were added in #1191.
 2022-11-15 19:15:34 +00:00
David Baker 26528c05c5 Newsfragment 2022-11-15 18:48:02 +00:00
Kévin Commaille b38cd08fbd
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-09 10:29:29 +01:00
Richard van der Hoff 498cf6d147
Merge pull request #1320 from zecakeh/master-pushrule 
Clarify that `.m.rule.master` has a higher priority than any push rule
 2022-11-08 21:56:39 +00:00
Richard van der Hoff b9952f1a74
Merge pull request #1329 from matrix-org/rav/htmltest 
Add link checker to CI
 2022-11-08 21:11:11 +00:00
Richard van der Hoff 44c7eb5b88
Merge pull request #1330 from matrix-org/rav/fix_dead_links 
Fix broken links
 2022-11-08 21:10:48 +00:00
David Baker f53da89996
Merge pull request #1318 from zecakeh/pushrules-set-sound 
Replace `set_sound` push rule action by `set_tweak`
 2022-11-08 20:49:46 +00:00
BramvdnHeuvel 6879f96c90
Require refresh_token on refresh token endpoint (#1323) 
Signed-off-by: Bram van den Heuvel matrix-spec@noordstar.me
 2022-11-08 19:24:37 +00:00
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
 2022-11-08 19:20:38 +00:00
Richard van der Hoff 8dd89e0510 changelog 2022-11-08 19:00:38 +00:00
Richard van der Hoff 4d0c912acf changelogs 2022-11-08 18:56:13 +00:00
Andrew Morgan fd41d9d4ed
Update docsy (hugo theme) git submodule (#1295) 2022-11-08 17:29:10 +00:00
Richard van der Hoff b07fe504ed
Stop rendering CS modules and room version fragments as standalone pages (#1317) 
This is actually doing two things:

 * creating `{fragments,modules}/index.md` turns the fragments and modules into
   page resources, rather than pages in their own right. We have to update the
   shortcodes to match.

 * adding `headless: true` means that we don't render the pages.

The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
 2022-11-08 17:27:44 +00:00
Kévin Commaille fc624328df
Change newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-08 17:53:58 +01:00
Richard van der Hoff 1945589acf
Clarifications to AS spec, including MSC3905 (#1305) 
Primarily this is the spec for MSC3905, but I've also taken the opportunity to clean up the section a bit and move the definition out to a .yaml file.
 2022-11-08 15:01:46 +00:00
Kévin Commaille f428ba1499
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-03 10:44:12 +01:00
Kévin Commaille 306d1aac5d
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-03 09:17:23 +01:00
Hubert Chathi 830f80f56a
Merge pull request #1271 from uhoreg/add_verification_request_msgtype 
add in-room m.key.verification.request msgtype
 2022-11-02 10:16:42 -04:00
Hubert Chathi 82d2dd4ab0
Merge pull request #1283 from uhoreg/fix_event_subtype 
improve display of event subtypes
 2022-11-02 10:15:56 -04:00
Hubert Chathi 2395dd87c0 more clarifications, and move event definitions to yaml 2022-11-01 17:49:45 -04:00
Alexandre Franke 39f79fe521
Update link to API viewer (#1308) 
* Update link to API viewer

Fixes #2
 2022-11-01 15:06:59 +00:00
Andrew Morgan c8242eeb35
Replace misuses of 'plaintext' with 'cleartext' and clarify spoiler docs (#1306) 2022-10-27 09:23:44 +00:00
Travis Ralston b2cc836649
Spec reference relationships (#1206) 
* Spec reference relationships

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

* Apply suggestions from code review

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

* Edits per code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2022-10-18 11:50:41 -06:00
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>
 2022-10-17 15:49:01 -06:00
Hubert Chathi 089f1fee7d add changelog 2022-10-12 16:02:07 -04:00
Richard van der Hoff 11cef5417a
Clarify auth rules for m.room.power_levels events (#1269) 2022-10-12 13:36:02 +01:00
Andrew Morgan 3808a679c1
Fix up description of knock_room_state field, which implied the required field was optional (#1276) 2022-10-07 13:46:37 +01:00
Richard van der Hoff c4505665e0
Various clarifications to auth rules text (#1270) 2022-10-05 16:54:34 +00:00
Andrew Morgan 43a48314ac
Remove reference to a room_id key for typing events (#1265) 2022-10-05 09:54:58 +00:00
Erik Johnston 4bda06a886
Merge pull request #1266 from matrix-org/erikj/clarfiy_otks 2022-10-05 10:02:27 +01:00
Hubert Chathi 9d8e17fb22 add changelog 2022-10-04 17:53:15 -04:00
Travis Ralston 1cdfbd3cd8
v1.4 patch release cleanup (#1268) 
* Add missing steps to patch release guidelines

* Update from v1.4 patch
 2022-10-04 10:00:16 -06:00
Erik Johnston b8e7c4e133 Newsfile 2022-10-04 16:01:55 +01:00
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>
 2022-10-04 08:09:23 -06:00
Val Lorentz 460bea4024
Fix definition of data-mx-color values (#1260) 
* Fix definition of `data-mx-color` values

* Create 1260.clarification

* Update changelogs/client_server/newsfragments/1260.clarification

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

Co-authored-by: Travis Ralston <travpc@gmail.com>
 2022-10-03 23:31:10 -04:00
Val Lorentz 3c796e9876
Aggregations: remove not about "future extensions" (#1263) 
* Aggregations: remove not about "future extensions"

It is now used by threading.

* Create 1263.clarification
 2022-10-03 23:26:31 -04:00
Travis Ralston 7a591366c1 v1.4 changelog 2022-09-29 07:03:48 -06:00
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
 2022-09-28 14:49:25 -06:00
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>
 2022-09-27 13:51:20 -06:00
Travis Ralston 6c6c602845
Clarify that refreshed access tokens don't invalidate the scope of txnid (#1236) 2022-09-26 14:39:43 -06:00
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>
 2022-09-22 09:04:50 -06:00
Andrew Morgan e7e376142e
Fix typos in the spec related to account data (#1243) 2022-09-22 11:25:32 +01:00
Richard van der Hoff 58e6900891
Spec event edits (#1211) 
Per matrix-org/matrix-spec-proposals#2676
 2022-09-21 14:41:28 +01:00
Patrick Cloke 1c0101ce4c Put commas between enum values. 2022-09-16 09:03:41 -04:00
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>
 2022-09-12 16:34:51 -06:00
David Robertson a6990ff27c
Fix spacing of mapping types (#1230) 
* Fix spacing of mapping types

* Changelog
 2022-09-06 10:21:51 -06:00
Will Hunt 8df0cfeae0
s/room/rooms (#1215) 
* s/room/rooms

Fixes #979

* Create 1215.clarification
 2022-08-26 13:53:28 -06:00
Andrew Morgan 5572d33453
Require access_token, device_id and user_id fields in /login response (#1210) 2022-08-16 18:12:10 +01:00
Richard van der Hoff 1930824898
include CS-api modules with {{< (#1205) 
... because that fixes everything. Or at least, #1204.
 2022-08-10 10:44:38 +01:00
Travis Ralston afc0e6a026
Add CORP headers to media repo (#1197) 
* Add CORP headers to media repo

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

* Write weird CSS rules to make added-in work inline in the CS spec

Even though our content doesn't need 2 paragraphs, it's good to have the capability to render it in the future.

* Remove test paragraph

* Refine prose

* spelling is key
 2022-08-09 10:44:51 -06:00
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
 2022-08-04 15:15:16 -06:00
Travis Ralston 9506ecea59
Add missing annotation for v1.4 on ACL push rule (#1201) 
* Add missing annotation for v1.4 on ACL push rule

* changelog
 2022-08-04 11:40:42 -06:00
Travis Ralston 6dc7b95e18
Use auth header instead of query param for hs->as comms (#1200) 
* Use auth header instead of query param for hs->as comms

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

* Fix for OpenAPI 2
 2022-08-04 11:33:16 -06:00
Richard van der Hoff ef384f1afd
Give rendered-data sections a background and some padding (#1195) 
Gives definition sections for APIs, events, etc a background and a small indent, which I find very helpful to guide the eye.
 2022-08-04 09:46:11 +00:00
Travis Ralston 9093a5f16f
Copy room type on upgrade too (#1198) 
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3818
 2022-08-03 13:09:14 -06:00
Travis Ralston 3c45c0aeb4
Remove unused policy room sharing mechanism, as per MSC3844 (#1196) 
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3844
 2022-08-03 11:31:24 -06:00
Richard van der Hoff dc4fd9bdd6
Render HTML anchors for definition blocks (#1191) 
It's handy to be able to link to these.
 2022-08-03 07:28:47 +01:00
Travis Ralston 569e139ac5
Add an "internal changes" changelog section (#1194) 
* Add an "internal changes" changelog section

* update changelog number
 2022-08-02 19:48:35 -06:00
Travis Ralston b36d4eff7d
Remove declared-invalid invite->knock restriction from auth rules (#1175) 
* Remove declared-invalid `invite->knock` restriction from auth rules

* Changelog

* real changelog
 2022-08-02 17:20:52 -06:00
Richard van der Hoff f24cad1653
Add push rule for m.room.server_acl (#1190) 
* Add push rule for `m.room.server_acl`

... per MSC3786.

* Update changelogs/client_server/newsfragments/1190.feature

Co-authored-by: Travis Ralston <travisr@matrix.org>
 2022-08-02 16:53:00 -06:00
David Robertson 69ff51c017
Tweak style of <code> samples in rendered tables (#1179) 
* Tweak style of `<code>` samples in rendered tables

This has been subtly irritating me for aaaaaaages

* Changelogs
 2022-08-02 14:49:27 +01:00
Richard van der Hoff b232148821
Clarify the use of JSON in requests and responses (#1185) 
Fixes #1182
 2022-07-28 13:45:54 +01:00
David Robertson 077f414cd0
Update changelogs/client_server/newsfragments/1180.clarification 
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2022-07-25 10:59:30 +01:00
David Robertson 494f903f71
Changelog 2022-07-21 18:47:54 +01:00
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.
 2022-07-19 22:02:48 +01:00
Richard van der Hoff 5f3b34448d
Add HTML ids for object definitions in the formatted specification (#1174) 
* Remove redundant call to resolve-allof

All of the callers to resolve-additional-types already call resolve-allof (or
if not, they should), so this is redundant.

* Update `resolve-additional-types` to take a dict

I want to add more params to this, so first make it take a dict.

* `render-object-table`: take a "title" rather than a "caption"

... which means we can use the result from resolve-additional-types directly.

* render-object-table: support adding an anchor to generated tables.

* resolve-additional-types: generate an id for each returned type

* render-event: pass an anchor_base into resolve-additional-types

This means that it will generate an anchor for each type, whihc will then be
passed into render-object-table and used as an `id` for the table.

* render-operation: pass an anchor_base into resolve-additional-types

* newsfiles
 2022-07-19 13:25:30 -06:00
David Robertson f9028acf8e
Describe return codes for account data endpoints + minor clarifications (#1155) 2022-07-14 13:01:56 +01:00
Travis Ralston 56400ab9a0
Add missing "added in" spec version to some key backup endpoints (#1170) 
* Add missing version to some key backup endpoints

* Create 1170.clarification
 2022-07-13 12:43:37 -06:00
Brad Murray ead437578b
Fix typo in m.secret.request device event name (#1135) 
* Fix typo in m.secret.request device event name

I don't think this is supposed to be plural according to the various SDKs

* Add changelog

* Update changelogs/client_server/newsfragments/1135.clarification

* Update changelogs/client_server/newsfragments/1135.clarification

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2022-07-12 10:59:44 -06:00
David Florness adaef611dc
Fix typo (#1161) 
Signed-off-by: David Florness <david@florness.com>
 2022-07-12 17:39:37 +01:00