Commit Graph

33 Commits (312a0e9b0504df8c33e8a2619fe179625ab399ea)

Author SHA1 Message Date
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
Hubert Chathi d0d7bdb807 apply changes from code review 2 years ago
Hubert Chathi d6345f0df2 apply changes from code review 2 years ago
Hubert Chathi 99cd692ed0 improve display of event subtypes 2 years ago
Travis Ralston 1cdfbd3cd8
v1.4 patch release cleanup (#1268)
* Add missing steps to patch release guidelines

* Update from v1.4 patch
2 years ago
Travis Ralston 7a591366c1 v1.4 changelog 2 years ago
Patrick Cloke 1c0101ce4c Put commas between enum values. 2 years ago
David Robertson a6990ff27c
Fix spacing of mapping types (#1230)
* Fix spacing of mapping types

* Changelog
2 years ago
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.
2 years ago
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
2 years ago
Travis Ralston 0dd3fa481b Fix changelog 2 years ago
Travis Ralston 98db9a6d04 v1.3 changelog generation 2 years ago
Richard van der Hoff dfb1bf2a5d
Fix `x-changedInMatrixVersion` for API parameters (#1011) 3 years ago
Richard van der Hoff f989d323c0
Update v1.2 changelog with missed PR (#3705) 3 years ago
Travis Ralston e488a7fb6d v1.2 changelog 3 years ago
Richard van der Hoff c3b53d5ae6
comments on resolve-allof (#3657) 3 years ago
Richard van der Hoff 783624d2cd
Fix rendering of responses with empty bodies (#3674) 3 years ago
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.
3 years ago
Richard van der Hoff 7f200c53e8
Move `prev_content` to unsigned (#3524) 3 years ago
Travis Ralston 67d73438ea Backport typo fix 3 years ago
Travis Ralston 195b8a54c5 v1.1 changelog 3 years ago
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
3 years ago
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
3 years ago
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>
3 years ago
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.
3 years ago
wbamberg 1bfc3de6d6 Merge pull request #2992 from wbamberg/support-changelogs
Support changelogs
3 years ago
wbamberg 6fc1f52f2f Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
3 years ago
wbamberg 942f865f64 Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
3 years ago
Will 5f45a897ef Add templates used to render data 3 years ago
Will ee87cf2b63
Undo support for patch versions; use an opaque version string 4 years ago
Will 338434bfcd
Support alerts (notes, warnings, rationales) 4 years ago
Will 0abbb1857f
Comments for all the layout templates 4 years ago
Will 55eae7b70b
Render a single page of the spec in Hugo 4 years ago