Commit Graph

6706 Commits (main)
 

Author SHA1 Message Date
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>
2 years ago
Patrick Cloke eeb43043ad
Add standard error responses (MSC3743). (#1347) 2 years ago
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>
2 years ago
Johannes Becker b2c4abf567
Clarify the power levels integer range (#1169)
Signed-off-by: Johannes Becker <j.becker@famedly.com>
2 years ago
David Baker 24b95cbb89
Merge pull request #1353 from HarHarLinks/patch-1
add missing description to m.call.answer schema
2 years ago
Kim Brose 8830314401
Create 1353.clarification 2 years ago
Kim Brose 8d378cfd51
add missing description to m.call.answer schema 2 years ago
Travis Ralston 3a84ea7cf6 Return to unstable 2 years ago
Travis Ralston 5f2fac89af Matrix 1.5 2 years ago
Travis Ralston 887344a16c Tag Matrix 1.5 2 years ago
Hubert Chathi 684ead8ab6
Merge pull request #1294 from uhoreg/rhul_clarifications
add some e2ee clarifications
2 years ago
Hubert Chathi 2fcc92c2fb
improve documentation of ephemeral events (#1284) 2 years ago
Hubert Chathi 64922771d4
Clarify that verifications without a request only happens over to-device (#1345) 2 years ago
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.
2 years ago
Andrew Morgan cb2d5653ee
Add Event Replacements, Threading and Reference Relations modules to module summary table (#1344) 2 years ago
Hubert Chathi 0f0caf582d more clarifications 2 years ago
Hubert Chathi 9fafadf311
Upgraded refusal to verify to a MUST
Co-authored-by: Denis Kasak <dkasak@termina.org.uk>
2 years ago
Andrew Morgan b5005e64f7
Document that non-spec changes should get an 'internal' changelog entry (#1342) 2 years ago
Richard van der Hoff f0246a5f12
Disable RSS for spec (#1346)
This should really fix #1336
2 years ago
Hubert Chathi 19e29e36af more clarifications 2 years ago
Richard van der Hoff 3c9139bd5d
Unpack spec into right place for htmltest (#1338)
Hopefully, fixes https://github.com/matrix-org/matrix-spec/issues/1336
2 years ago
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.
2 years ago
Hubert Chathi d0cbd4c8dd
Apply suggestions from code review
Co-authored-by: Denis Kasak <dkasak@termina.org.uk>
2 years ago
David Baker 678f8b96f0
Merge pull request #1341 from matrix-org/dbkr/add_read_receipt_example
Add example read receipt to sync example
2 years ago
David Baker d620ff7a7c
Better newsfragment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2 years ago
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.
2 years ago
David Baker 26528c05c5 Newsfragment 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 ac1c5ad2bb
Merge pull request #1331 from zecakeh/swagger-preview
Update instructions to preview Swagger definitions
2 years ago
Richard van der Hoff 12b4d8ad95
Update README.md 2 years ago
Kévin Commaille b38cd08fbd
Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Kévin Commaille 9b4773498a
Update instructions to preview Swagger definitions
Use RapiDoc, the same library used in production.
It is also compatible with OpenAPI 3.1.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
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
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
David Baker f53da89996
Merge pull request #1318 from zecakeh/pushrules-set-sound
Replace `set_sound` push rule action by `set_tweak`
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 8dd89e0510 changelog 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 3e074ed6d3 Add htmltest github action 2 years ago
Richard van der Hoff 4d0c912acf changelogs 2 years ago
Richard van der Hoff 6cbb88f9df Fix broken links
A bunch of broken links I found
2 years ago
Andrew Morgan fd41d9d4ed
Update docsy (hugo theme) git submodule (#1295) 2 years ago
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/.
2 years ago
Kévin Commaille fc624328df
Change newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
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.
2 years ago
Kévin Commaille f428ba1499
Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Kévin Commaille ea7e1c8af9
Clarify that `.m.rule.master` has a higher priority than any push rule
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Kévin Commaille 306d1aac5d
Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago