archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make resolve-allof recursive

Browse Source 
Makes it easier to use, like resolve-refs. It just needs to be called once.

Fixes an issue with m.call.* events not displaying the common fields

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
pull/1787/head
Kévin Commaille 2 months ago
parent becc667672
commit 0cbdc73891
No known key found for this signature in database
GPG Key ID: 29A48C1F03620416
7 changed files with 68 additions and 93 deletions
Show Stats Download Patch File Download Diff File

11
layouts/partials/json-schema/resolve-additional-types.html
Unescape Escape View File

@ -20,10 +20,6 @@
* The returned entries are based on the JSON schema definitions found by
* recursing through the input `schema`, with the following differences:
*
* * `allOf` references are expanded. (Although this partial requires that
* `resolve-allof` is called on the top-level `schema` beforehand,
* `resolve-allof` doesn't recurse down to subschemas).
*
* * If `anchor_base` is set, each object with a `title` and `properties`
* is given an `anchor`, which is a string suitable for using as an html
* anchor for that object schema.
@ -210,12 +206,7 @@
{{ errorf "Invalid call to partials/get-additional-objects: %s is not a map" $name .this_object }}
{{ end }}
/* Although we expect resolve-allof to be called on the input, resolve-allof does not recurse into
* nested schemas, so we have to call it again.
*/
{{ $this_object := partial "json-schema/resolve-allof" .this_object }}
{{ $res := partial "resolve-additional-types-inner" (dict "schema" $this_object "anchor_base" .anchor_base "name" $name) }}
{{ $res := partial "resolve-additional-types-inner" (dict "schema" .this_object "anchor_base" .anchor_base "name" $name) }}
{{ range $res.objects }}
{{ $all_objects = $all_objects | append (partial "clean-object" .) }}
{{ end }}

85
layouts/partials/json-schema/resolve-allof.html
Unescape Escape View File

@ -1,7 +1,7 @@
{{/*
Resolves the `allOf` keyword (https://spec.openapis.org/oas/v3.1.0#composition-and-inheritance-polymorphism),
given a JSON schema object.
Resolves the `allOf` keyword (https://spec.openapis.org/oas/v3.1.0#composition-and-inheritance-polymorphism)
recursively, given a JSON schema object.
`allOf` is used to support a kind of inheritance for JSON schema objects.
@ -11,28 +11,44 @@
Of course the parent can itself inherit from *its* parent, so we recurse to
handle that.
Note that `allOf` is only resolved at the top level of the schema object. For
example, if you call this on an API definition which defines a `parameter`
which has an allOf schema, it will not be resolved. To handle this, the
openapi templates call resolve-allof for every schema object that they
process.
*/}}
{{ $ret := . }}
{{ $original := . }}
{{/*
{{ if reflect.IsSlice $ret }}
{{/*
If it's a slice, just recurse.
*/}}
{{ $result_slice := slice }}
{{ range $ret }}
{{ $resolved := partial "json-schema/resolve-allof" . }}
{{ $result_slice = $result_slice | append $resolved }}
{{ end }}
{{ $ret = $result_slice }}
{{ end }}
{{ if reflect.IsMap $ret }}
{{/*
First, we recurse into the other keys. Doing it now avoids to recurse
twice in keys resolved by allOf values.
*/}}
{{ range $key, $value := $ret }}
{{ if ne $key "allOf" }}
{{ $resolved := partial "json-schema/resolve-allof" $value }}
{{ $ret = merge $ret (dict $key $resolved) }}
{{ end }}
{{ end }}
{{/*
We special-case 'required', and accumulate the values from all the 'allOf'
entries (rather than simply overriding them). Start the accumulation here.
*/}}
{{ $required := .required }}
{{ if not $required }}
*/}}
{{ $required := slice }}
{{ end }}
{{ with $ret.allOf }}
{{ with $ret.allOf }}
{{/*
construct a new dict, with each of the allOf entries merged into it in
@ -40,7 +56,12 @@
*/}}
{{ $all_of_values := dict }}
{{ range . }}
{{ with .required }}
{{/*
First, resolve allOf in child.
*/}}
{{ $resolved := partial "json-schema/resolve-allof" . }}
{{ with $resolved.required }}
{{ $required = union $required . }}
{{ end }}
@ -51,7 +72,7 @@
Note also that `merge` does a *deep* merge - nested maps are also
merged. (Slices are replaced though.)
*/}}
{{ $all_of_values = merge $all_of_values . }}
{{ $all_of_values = merge $all_of_values $resolved }}
{{ end }}
{{/*
@ -59,44 +80,16 @@
*/}}
{{ $ret = merge $all_of_values $ret }}
{{/*
Except that if allOf *itself* contains allOf (ie, the parent also
inherits from a grandparent), then we replace allOf in the original
with that in the parent. Below, we see that this has happened, and
recurse.
TODO: surely it would be better to simply do the recursion as we iterate
though the allOf list above - not least because we might have multiple
parents with different grandparents, and by doing this we only get one
set of grandparents.
*/}}
{{ with $all_of_values.allOf }}
{{ $ret = merge $ret (dict "allOf" . ) }}
{{ end }}
{{/*
special-case 'required': replace it with the union of all the
'required' arrays from the original and allOf values.
XXX: but first we merge in the original 'required', again? why
do we do that? it should already have been done at the start.
*/}}
{{ with $ret.required }}
{{ $required = union $required $ret.required }}
{{ end }}
{{ $ret = merge $ret (dict "required" $required) }}
{{ end }}
{{/*
If we replaced the 'allOf' dict with one from a grandparent, we now
need to recurse.
*/}}
{{ if ne $ret.allOf $original.allOf }}
{{ $resolved := partial "json-schema/resolve-allof" $ret }}
{{ $ret = merge $ret $resolved }}
{{ end }}
{{ end }}
{{ return $ret }}

2
layouts/partials/json-schema/resolve-example.html
Unescape Escape View File

@ -9,7 +9,7 @@
*/}}
{{ $this_object := partial "json-schema/resolve-allof" . }}
{{ $this_object := . }}
{{ $example := $this_object.example }}

12
layouts/partials/openapi/render-object-table.html
Unescape Escape View File

@ -38,9 +38,6 @@
</thead>
{{ range $property_name, $property := $properties }}
{{ $property := partial "json-schema/resolve-allof" $property }}
{{/*
Handle two ways of indicating "required", one for simple parameters,
the other for request and response body objects.
@ -67,7 +64,7 @@
<th class="col-description">Description</th>
</thead>
{{ $property := partial "json-schema/resolve-allof" . }}
{{ $property := . }}
<tr>
<td><code>{{ partial "partials/property-type" $property }}</code></td>
@ -112,9 +109,6 @@
*/}}
{{ if eq .type "array"}}
{{ $items := .items }}
{{ if .items }}
{{ $items = partial "json-schema/resolve-allof" .items }}
{{ end }}
{{ $inner_type := partial "type-or-title" $items }}
{{ $type = delimit (slice "[" $inner_type "]") "" }}
{{ end }}
@ -158,8 +152,7 @@
If the property uses `additionalProperties` to describe its
internal structure, handle this with a bit of recursion
*/}}
{{ $additionalProperties := partial "json-schema/resolve-allof" .additionalProperties }}
{{ $type = delimit (slice "{string: " (partial "property-type" $additionalProperties) "}" ) "" }}
{{ $type = delimit (slice "{string: " (partial "property-type" .additionalProperties) "}" ) "" }}
{{ else if reflect.IsMap .patternProperties }}
{{/*
If the property uses `patternProperties` to describe its
@ -171,7 +164,6 @@
{{ $types := slice }}
{{ range $pattern, $schema := .patternProperties}}
{{ $schema = partial "json-schema/resolve-allof" $schema }}
{{ $types = $types | append (partial "property-type" $schema) }}
{{ end }}

6
layouts/partials/openapi/render-request.html
Unescape Escape View File

@ -40,7 +40,7 @@
{{/*
Display the JSON schemas
*/}}
{{ $schema := partial "json-schema/resolve-allof" $json_body.schema }}
{{ $schema := $json_body.schema }}
{{ $additional_types := partial "json-schema/resolve-additional-types" (dict "schema" $schema "anchor_base" $anchor_base) }}
{{ range $additional_types }}
@ -67,9 +67,7 @@
{{ $example := dict }}
{{ if $body.schema }}
{{ $schema := partial "json-schema/resolve-allof" $body.schema }}
{{ $example = partial "json-schema/resolve-example" $schema }}
{{ $example = partial "json-schema/resolve-example" $body.schema }}
{{ end }}
{{ if and (eq ($example | len) 0) $body.example }}

2
layouts/partials/openapi/render-responses.html
Unescape Escape View File

@ -47,7 +47,7 @@
Display the JSON schemas
*/}}
{{ $schema := partial "json-schema/resolve-allof" $json_body.schema }}
{{ $schema := $json_body.schema }}
{{/*
All this is to work out how to express the content of the response

1
layouts/shortcodes/http-api.html
Unescape Escape View File

@ -24,5 +24,6 @@
{{ $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) }}

Write Preview
Loading…
Cancel
Save