mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-22 05:53:42 +01:00
f7f641aae7
A big change for template paths landed in Hugo 0.146.0. In `layouts`, we: - remove `_default` and move everything in it directly under `layouts` - rename `partials` and `shortcodes` to `_partials` and `_shortcodes` - adapt to Hugo and docsy changes about the render-heading hook. We don't need a copy of the heading self-link template now that it is defined as a partial. - update `docs/baseof.html` to match a change upstream - split `docs/changelog.html` because it doesn't work for the section page anymore. We create a `changelog-index` layout for this. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
34 lines
1.2 KiB
HTML
34 lines
1.2 KiB
HTML
{{/*
|
|
|
|
This template is used to render an HTTP API, given an OpenAPI definition.
|
|
|
|
It expects to be passed two parameters:
|
|
|
|
* a `spec` parameter identifying the spec, which must be the name of
|
|
a directory under /data/api
|
|
* an `api` parameter, identifying an OpenAPI definition,
|
|
which is the name of a schema file under "data/api/$spec".
|
|
The file extension is omitted. For example:
|
|
|
|
{{% http-api spec="server-server" api="public_rooms" %}}
|
|
* an optional `anchor_base` parameter, which should be used as a
|
|
prefix for the HTML IDs generated by this template. It should only
|
|
be necessary to provide one for duplicate endpoints.
|
|
|
|
This template replaces the old {{*_http_api}} template.
|
|
|
|
*/}}
|
|
|
|
{{ $spec := .Params.spec}}
|
|
{{ $api := .Params.api}}
|
|
{{ $anchor_base := .Params.anchor_base}}
|
|
|
|
{{ $api_data := index .Site.Data.api .Params.spec .Params.api }}
|
|
{{ $base_url := (index $api_data.servers 0).variables.basePath.default }}
|
|
{{ $path := delimit (slice "api" $spec $api) "/" }}
|
|
|
|
{{ $api_data = partial "json-schema/resolve-refs" (dict "schema" $api_data "path" $path) }}
|
|
{{ $api_data = partial "json-schema/resolve-allof" $api_data }}
|
|
|
|
{{ partial "openapi/render-api" (dict "api_data" $api_data "base_url" $base_url "anchor_base" $anchor_base) }}
|