Commit graph

35 commits

Author SHA1 Message Date
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
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
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
Hubert Chathi d0d7bdb807 apply changes from code review 2022-11-01 11:39:15 -04:00
Hubert Chathi d6345f0df2 apply changes from code review 2022-10-26 16:33:41 -04:00
Hubert Chathi 99cd692ed0 improve display of event subtypes 2022-10-12 15:49:21 -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
Travis Ralston 7a591366c1 v1.4 changelog 2022-09-29 07:03:48 -06:00
Patrick Cloke 1c0101ce4c Put commas between enum values. 2022-09-16 09:03:41 -04:00
David Robertson a6990ff27c
Fix spacing of mapping types (#1230)
* Fix spacing of mapping types

* Changelog
2022-09-06 10:21:51 -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
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
Travis Ralston 0dd3fa481b Fix changelog 2022-06-16 09:17:08 -06:00
Travis Ralston 98db9a6d04 v1.3 changelog generation 2022-06-16 08:31:07 -06:00
Richard van der Hoff dfb1bf2a5d
Fix x-changedInMatrixVersion for API parameters (#1011) 2022-03-29 23:17:51 +01:00
Richard van der Hoff f989d323c0
Update v1.2 changelog with missed PR (#3705) 2022-02-11 11:05:49 +00:00
Travis Ralston e488a7fb6d v1.2 changelog 2022-02-02 10:05:30 -07:00
Richard van der Hoff c3b53d5ae6
comments on resolve-allof (#3657) 2022-01-26 10:50:48 +00:00
Richard van der Hoff 783624d2cd
Fix rendering of responses with empty bodies (#3674) 2022-01-26 10:50:09 +00:00
Richard van der Hoff 3be746c9d3
Fix rendering of response examples (#3584)
* Fix rendering of response examples

Fixes the autogeneration of JSON examples for array objects. This fixes a
number of "Specification error: Example invalid or not present" errors in the
rendered spec.

* Unbreak examples for non-objects/arrays

The previous change had broken auto-generated examples for everything that
wasn't an object or array; fix it up again.

* Remove conditions on $example

Everything should now have a generated example, so the condition is
redundant. Furthermore it was suppressing examples for APIs where the example
was an empty dict.
2022-01-04 16:47:58 +00:00
Richard van der Hoff 7f200c53e8
Move prev_content to unsigned (#3524) 2021-12-02 17:22:58 +00:00
Travis Ralston 67d73438ea Backport typo fix 2021-11-09 08:19:21 -07:00
Travis Ralston 195b8a54c5 v1.1 changelog 2021-11-09 07:23:27 -07:00
Travis Ralston e8674688e6
Release process: changelog generation and docs (#3446)
* Remove extra pyprojects and update changelog docs

* Add script for rendering the changelog

* Add docs for how to release the spec

* Move legacy changelogs out of the way
2021-10-18 10:09:35 -06:00
Travis Ralston 5be0df02c5
Start annotating which version of the spec added a thing (#3425)
* Introduce a new "added-in" template and use it on endpoints

* Use "added-in" on schema properties too

* Annotate sections of the spec with their added versions

* Demo of "added-in" on a room version (to be fleshed out)

* Use clearer versioning semantics

* Update and fix validator for Swagger custom properties

* Fix docs
2021-10-14 13:23:04 -06:00
Andrew Morgan ff2c93af1c Use changelogs/release.yaml for the version number source everywhere (#3310)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2021-08-27 19:17:17 +01:00
Andrew Morgan 97f8e1248b Attempt to fix broken breadcrumb links
Apparently this is a bug when canonifyURLs = true, which is a required option
to fix relative urls on spec pages.
2021-08-27 19:17:07 +01:00
wbamberg 1bfc3de6d6 Merge pull request #2992 from wbamberg/support-changelogs
Support changelogs
2021-08-27 19:16:42 +01:00
wbamberg 6fc1f52f2f Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-08-27 19:16:42 +01:00
wbamberg 942f865f64 Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-08-27 19:16:42 +01:00
Will 5f45a897ef Add templates used to render data 2021-08-27 19:16:42 +01:00
Will ee87cf2b63
Undo support for patch versions; use an opaque version string 2021-02-08 20:35:04 -08:00
Will 338434bfcd
Support alerts (notes, warnings, rationales) 2021-01-20 12:34:49 -08:00
Will 0abbb1857f
Comments for all the layout templates 2021-01-12 20:45:24 -08:00
Will 55eae7b70b
Render a single page of the spec in Hugo 2021-01-12 15:31:01 -08:00