eb656dfce3
Add missing `x-addedInMatrixVersion` to `servers_in_room` in `v2/send_join` ( #1398 )
...
* Add missing `x-addedInMatrixVersion` to `servers_in_room` in `v2/send_join`
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>
2 years ago
b8411b5159
Spec `omit_members` for `/v2/send_join` ( #1393 )
...
Per MSC3706
2 years ago
9e45037129
Remove `keyId` from the server keys endpoints ( #1350 )
...
* Remove keyId from the server keys endpoints
It has been deprecated forever.
Besides, the OpenAPI 3 spec doesn't allow optional path parameters.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Fix broken link
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Mention MSC3938 in newfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
eb2456c7d4
Improve documentation around one-time keys and key types ( #1381 )
2 years ago
94465fe93b
Add spec for getting events by timestamp ( #1366 )
2 years ago
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
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
2 years ago
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
2 years ago
f386c903c0
Clarify that CNAMEs are permissible for server names ( #1376 )
...
Fixes https://github.com/matrix-org/matrix-spec/issues/606 .
2 years ago
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
2 years ago
9555cbe5a9
Fix incorrect default "Invite level" ( #1371 )
2 years ago
2e789736cc
Add newsfragment
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
e481fd011a
Add link to the unstable spec to the README ( #1357 )
2 years ago
8d4a3bb912
Clarify what fields are required when deleting a pusher ( #1321 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
84fbb611db
Clarify that /context always returns 'event' even if limit is zero ( #1239 )
...
Signed-off-by: Sumner Evans <me@sumnerevans.com>
2 years ago
3f3b5c39f0
Remove duplicated "Note:" from `m.room.power_levels` ( #1355 )
...
Remove duplicated "Note:"
Signed-off-by: Johannes Becker <j.becker@famedly.com>
2 years ago
07442876ce
Improve presentation of push rules kinds and actions ( #1348 )
2 years ago
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>
2 years ago
eeb43043ad
Add standard error responses (MSC3743). ( #1347 )
2 years ago
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>
2 years ago
b2c4abf567
Clarify the power levels integer range ( #1169 )
...
Signed-off-by: Johannes Becker <j.becker@famedly.com>
2 years ago
8830314401
Create 1353.clarification
2 years ago
5f2fac89af
Matrix 1.5
2 years ago
684ead8ab6
Merge pull request #1294 from uhoreg/rhul_clarifications
...
add some e2ee clarifications
2 years ago
2fcc92c2fb
improve documentation of ephemeral events ( #1284 )
2 years ago
64922771d4
Clarify that verifications without a request only happens over to-device ( #1345 )
2 years ago
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.
2 years ago
cb2d5653ee
Add Event Replacements, Threading and Reference Relations modules to module summary table ( #1344 )
2 years ago
b5005e64f7
Document that non-spec changes should get an 'internal' changelog entry ( #1342 )
2 years ago
f0246a5f12
Disable RSS for spec ( #1346 )
...
This should really fix #1336
2 years ago
3c9139bd5d
Unpack spec into right place for htmltest ( #1338 )
...
Hopefully, fixes https://github.com/matrix-org/matrix-spec/issues/1336
2 years ago
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 .
2 years ago
678f8b96f0
Merge pull request #1341 from matrix-org/dbkr/add_read_receipt_example
...
Add example read receipt to sync example
2 years ago
d620ff7a7c
Better newsfragment
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2 years ago
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 .
2 years ago
26528c05c5
Newsfragment
2 years ago
b38cd08fbd
Add newsfragment
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
498cf6d147
Merge pull request #1320 from zecakeh/master-pushrule
...
Clarify that `.m.rule.master` has a higher priority than any push rule
2 years ago
b9952f1a74
Merge pull request #1329 from matrix-org/rav/htmltest
...
Add link checker to CI
2 years ago
44c7eb5b88
Merge pull request #1330 from matrix-org/rav/fix_dead_links
...
Fix broken links
2 years ago
f53da89996
Merge pull request #1318 from zecakeh/pushrules-set-sound
...
Replace `set_sound` push rule action by `set_tweak`
2 years ago
6879f96c90
Require refresh_token on refresh token endpoint ( #1323 )
...
Signed-off-by: Bram van den Heuvel matrix-spec@noordstar.me
2 years ago
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
8dd89e0510
changelog
2 years ago
4d0c912acf
changelogs
2 years ago
fd41d9d4ed
Update docsy (hugo theme) git submodule ( #1295 )
2 years ago
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/ .
2 years ago
fc624328df
Change newsfragment
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
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.
2 years ago
f428ba1499
Add newsfragment
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
306d1aac5d
Add newsfragment
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
830f80f56a
Merge pull request #1271 from uhoreg/add_verification_request_msgtype
...
add in-room m.key.verification.request msgtype
2 years ago
82d2dd4ab0
Merge pull request #1283 from uhoreg/fix_event_subtype
...
improve display of event subtypes
2 years ago
2395dd87c0
more clarifications, and move event definitions to yaml
2 years ago
39f79fe521
Update link to API viewer ( #1308 )
...
* Update link to API viewer
Fixes #2
2 years ago
c8242eeb35
Replace misuses of 'plaintext' with 'cleartext' and clarify spoiler docs ( #1306 )
2 years ago
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>
2 years ago
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
089f1fee7d
add changelog
2 years ago
11cef5417a
Clarify auth rules for `m.room.power_levels` events ( #1269 )
2 years ago
3808a679c1
Fix up description of `knock_room_state` field, which implied the required field was optional ( #1276 )
2 years ago
c4505665e0
Various clarifications to auth rules text ( #1270 )
2 years ago
43a48314ac
Remove reference to a `room_id` key for typing events ( #1265 )
2 years ago
4bda06a886
Merge pull request #1266 from matrix-org/erikj/clarfiy_otks
2 years ago
9d8e17fb22
add changelog
2 years ago
1cdfbd3cd8
v1.4 patch release cleanup ( #1268 )
...
* Add missing steps to patch release guidelines
* Update from v1.4 patch
2 years ago
b8e7c4e133
Newsfile
2 years ago
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
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>
2 years ago
3c796e9876
Aggregations: remove not about "future extensions" ( #1263 )
...
* Aggregations: remove not about "future extensions"
It is now used by threading.
* Create 1263.clarification
2 years ago
7a591366c1
v1.4 changelog
2 years ago
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
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
6c6c602845
Clarify that refreshed access tokens don't invalidate the scope of txnid ( #1236 )
2 years ago
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
e7e376142e
Fix typos in the spec related to account data ( #1243 )
2 years ago
58e6900891
Spec event edits ( #1211 )
...
Per matrix-org/matrix-spec-proposals#2676
2 years ago
1c0101ce4c
Put commas between enum values.
2 years ago
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
a6990ff27c
Fix spacing of mapping types ( #1230 )
...
* Fix spacing of mapping types
* Changelog
2 years ago
8df0cfeae0
s/room/rooms ( #1215 )
...
* s/room/rooms
Fixes #979
* Create 1215.clarification
2 years ago
5572d33453
Require `access_token`, `device_id` and `user_id` fields in `/login` response ( #1210 )
2 years ago
1930824898
include CS-api modules with `{{<` ( #1205 )
...
... because that fixes everything. Or at least, #1204 .
2 years ago
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
2 years ago
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
9506ecea59
Add missing annotation for v1.4 on ACL push rule ( #1201 )
...
* Add missing annotation for v1.4 on ACL push rule
* changelog
2 years ago
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
2 years ago
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.
2 years ago
9093a5f16f
Copy room `type` on upgrade too ( #1198 )
...
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3818
2 years ago
3c45c0aeb4
Remove unused policy room sharing mechanism, as per MSC3844 ( #1196 )
...
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3844
2 years ago
dc4fd9bdd6
Render HTML anchors for definition blocks ( #1191 )
...
It's handy to be able to link to these.
2 years ago
569e139ac5
Add an "internal changes" changelog section ( #1194 )
...
* Add an "internal changes" changelog section
* update changelog number
2 years ago
b36d4eff7d
Remove declared-invalid `invite->knock` restriction from auth rules ( #1175 )
...
* Remove declared-invalid `invite->knock` restriction from auth rules
* Changelog
* real changelog
2 years ago
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>
2 years ago
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
2 years ago
b232148821
Clarify the use of JSON in requests and responses ( #1185 )
...
Fixes #1182
2 years ago
077f414cd0
Update changelogs/client_server/newsfragments/1180.clarification
...
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
2 years ago
494f903f71
Changelog
2 years ago
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
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
2 years ago
Kévin Commaille