976ebdca2f
Update HTML templates to link to object definitions ( #1724 )
9 months ago
b136b357e0
Update docsy to v0.8.0 ( #1699 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
9 months ago
650e691a22
Fix npm release script ( #1713 )
...
* Fix npm release script
* Create 1713.misc
11 months ago
4a80df364a
Wording tweak in CONTRIBUTING.rst ( #1697 )
12 months ago
59f8d632a3
Add step to release process to remind ourselves to reach out to Advocacy ( #1680 )
...
* Add step to release process to remind ourselves to reach out to Advocacy
* changelog
1 year ago
0c099e3b79
Matrix 1.9
1 year ago
634b24fb25
Normalize changelog for 1.9
1 year ago
560d98ba9b
Add more CI checks for OpenAPI definitions and JSON Schemas ( #1656 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
1 year ago
c71b528148
Upgrade GitHub actions ( #1660 )
...
* Upgrade most github actions
Gets rid of warning in CI complaining about those actions
using node 12.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Upgrade node version used to run scripts
Use the latest LTS
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
72517c0f9c
Generate server-server OpenAPI definition ( #1657 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
e40d9ca186
Fix rendering of `m.receipt` event in Client-Server API ( #1637 )
...
... and other improvements
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
1 year ago
5672bdbab7
Fix enum types in JSON schemas ( #1634 )
...
`type: enum` does not exist, as an enum can be of any type.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
f11c5600a2
Fix npm package release automation ( #1648 )
1 year ago
99e2ff4927
Replace all mentions of Swagger by OpenAPI ( #1633 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
df3f0af5d4
Fix schema of `m.mentions` object ( #1635 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
529cbf4ffc
Matrix 1.8 changelog
1 year ago
06298e4d8d
Normalize changelog for Matrix 1.8
...
See https://github.com/matrix-org/matrix-spec/issues/1614
1 year ago
c0babbfc13
Create @matrix-org/spec npm package containing sas-emoji.json ( #1620 )
...
* Create packages/npm @matrix-org/spec npm package containing spec-emoji
* Initial workflow script
* Add newsfragment
* Add docs
* npm publish doesn't like symlinks, yarn does :((
1 year ago
f5035b8e02
Fix up attribution
...
Per request at https://github.com/matrix-org/matrix-spec/pull/1601#discussion_r1269035798
1 year ago
1a11a7b998
Use auto table-layout on desktop ( #1601 )
...
Signed-off-by: Martin Fischer <martin@push-f.com>
1 year ago
639caf057d
Fix rendered changelog with new version of towncrier ( #1598 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
903b206e3b
Specify our usage of ABNF for grammar ( #1582 )
...
* Specify our usage of ABNF for grammar
* Create 1582.clarification
* Update meta/documentation_style.rst
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
b2ab339ba6
Bump hugo version used for the build ( #1591 )
...
Since https://github.com/matrix-org/matrix-spec/issues/1544 is fixed, we can
use a modern hugo.
1 year ago
a6eb381ebb
Fix the sidebar in recent versions of Hugo ( #1551 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
4a9bda9bed
Use tag name as the OpenAPI definition version ( #1561 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
adff3faa35
Make sure version in x-changedInMatrixVersion is a string ( #1562 )
2 years ago
3c5355a278
Use Redocly CLI to validate OpenAPI definitions ( #1558 )
2 years ago
f4aa7c0327
Bump the version of jsonschema ( #1556 )
...
* Bump the version of jsonschema
OpenAPI 3.1 uses JSON Schema Draft 2020-12 so we need a version that
supports it.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Fix PR number
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---------
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
45b6aaf07a
Upgrade Swagger data to OpenAPI 3.1 ( #1310 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
c64a616d54
Update the changelog entry checker script to check newsfragment file extension ( #1542 )
2 years ago
48459dee9b
Only include titles in summaries ( #1549 )
...
I previously made this change for HTTP endpoints in #1446 . It seems there are
other places where we have over-sized `<summary>` elements. I would like
to elimintate those too, as grumbled about in
https://github.com/matrix-org/matrix-spec/issues/1358#issuecomment-1325220859
and
https://github.com/matrix-org/matrix-spec/issues/1352#issuecomment-1439033334
2 years ago
8b51f1c011
Matrix 1.7
2 years ago
fbb8a789f6
Add release checklist issue template; Document some of our timelines around releases ( #1538 )
...
* Add a spec release checklist issue template
because I'm tired of copy/paste
* Document a chunk of our release approach
This should probably go elsewhere, but here is fine for now as a SCT-referenced doc/content.
* changelog
* Brief clarifications
2 years ago
d028dc4b82
Normalize changelog for v1.7
2 years ago
17ebdf7c86
Fix ASCII art alignment ( #1534 )
...
* Fix ASCII art alignment
Signed-off-by: Michael Kohler <me@michaelkohler.info>
Fixes #1430
* Add changelog
---------
Co-authored-by: Travis Ralston <travpc@gmail.com>
2 years ago
c662976fab
Fix generation of anchors for additional properties ( #1488 )
...
but objects defined under `additionalProperties` missed out on them. This fixes
that.
2 years ago
ac8d34bc81
Cleanups to github actions workflow ( #1476 )
2 years ago
f9ea0f9d9b
Only include endpoint path in `<summary>` ( #1446 )
2 years ago
a9e9202e89
Load Inter CSS directly ( #1444 )
...
Move the load of the Inter font CSS from _variables_project.scss to head-end.html.
Empirically, this seems to fix #965
2 years ago
029e988835
Matrix 1.6
2 years ago
5c485ade2e
Prepare changelogs for v1.6
2 years ago
d4586eba2e
Improve formatting of definitions in the Push Notifications section ( #1415 )
...
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
2 years ago
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>
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
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
e481fd011a
Add link to the unstable spec to the README ( #1357 )
2 years ago
5f2fac89af
Matrix 1.5
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
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
b38cd08fbd
Add newsfragment
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
8dd89e0510
changelog
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
39f79fe521
Update link to API viewer ( #1308 )
...
* Update link to API viewer
Fixes #2
2 years ago
7a591366c1
v1.4 changelog
2 years ago
a6990ff27c
Fix spacing of mapping types ( #1230 )
...
* Fix spacing of mapping types
* Changelog
2 years ago
1930824898
include CS-api modules with `{{<` ( #1205 )
...
... because that fixes everything. Or at least, #1204 .
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
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
Richard van der Hoff