mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-05 15:33:43 +01:00
bc15d4f9bc
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.
68 lines
1.8 KiB
HTML
68 lines
1.8 KiB
HTML
{{/*
|
|
|
|
This template is used to render EDUs and PDUs in the server-server and room versions specs.
|
|
|
|
It expects to be passed a `path` parameter, which is a path, relative to /data,
|
|
pointing to a schema file. The file extension is omitted. For example:
|
|
|
|
{{% definition path="api/server-server/definitions/edu" %}}
|
|
|
|
This template replaces the old {{definition_*}} template.
|
|
|
|
*/}}
|
|
|
|
{{ $path := .Params.path }}
|
|
{{ $compact := .Params.compact }}
|
|
{{ $pieces := split $path "/" }}
|
|
|
|
{{/* The definition is referenced by the .path parameter */}}
|
|
{{ $definition := index .Site.Data $pieces }}
|
|
|
|
{{ if not $definition }}
|
|
{{ errorf "site data %s not found" $path }}
|
|
{{ end }}
|
|
|
|
{{/* The base path, which we use to resolve $ref, omits the last component */}}
|
|
{{ $pieces = first (sub (len $pieces) 1) $pieces}}
|
|
{{ $path = delimit $pieces "/" }}
|
|
|
|
{{/* Resolve $ref and allOf */}}
|
|
{{ $definition = partial "json-schema/resolve-refs" (dict "schema" $definition "path" $path) }}
|
|
{{ $definition = partial "json-schema/resolve-allof" $definition }}
|
|
|
|
<section class="rendered-data definition" id="definition-{{ anchorize $definition.title }}">
|
|
|
|
<details {{ if not $compact }}open{{ end }}>
|
|
<summary>
|
|
|
|
<h1>
|
|
<code>{{ $definition.title }}</code>
|
|
</h1>
|
|
|
|
<hr/>
|
|
|
|
{{ if (index $definition "x-addedInMatrixVersion") }}
|
|
{{ partial "added-in" (dict "v" (index $definition "x-addedInMatrixVersion")) }}
|
|
{{ end }}
|
|
|
|
{{ $definition.description | markdownify }}
|
|
|
|
</summary>
|
|
|
|
{{ $additional_types := partial "json-schema/resolve-additional-types" (dict "schema" $definition) }}
|
|
{{ $additional_types = uniq $additional_types }}
|
|
|
|
{{ range $additional_types }}
|
|
{{ partial "openapi/render-object-table" . }}
|
|
{{end}}
|
|
|
|
<h2>Examples</h2>
|
|
|
|
{{ $example := partial "json-schema/resolve-example" $definition }}
|
|
|
|
```json
|
|
{{ jsonify (dict "indent" " ") $example }}
|
|
```
|
|
|
|
</section>
|