Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 04:54:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Use phrasing "Notes on additional properties"

Browse source 
Ignore `true` values for additionalProperties. Error on `false` values.
This commit is contained in:
David Robertson 2022-07-21 16:12:07 +01:00
parent 9bc952ef03
commit 3398cf0f63
No known key found for this signature in database
GPG key ID: 903ECE108A39DEDD
1 changed files with 8 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
layouts/partials/openapi/render-object-table.html
View file

@ -94,24 +94,21 @@
{{ end }}
{{/* NB: the OpenAPI spec says "Consistent with JSON Schema, additionalProperties
defaults to true." Our schemas tend to omit additionalProperties; I think we
effectively assume it defaults to false. Therefore: we only output regarding
additionalProperties if it is explicitly set (i.e. is non-nil). */}}
{{/* Additional properties should either be an OpenAPI schema object, or a
boolean. If it's the former, look for a `description` and render it as a note.
If it's `true`, do nothing. If it's `false`, raise a build-time error:
"Everything is extensible in Matrix unless otherwise noted". */}}
{{ if (ne $additionalProperties nil )}}
<tr class="row-additional-properties">
<td colspan="3">
{{ if (and (reflect.IsMap $additionalProperties)) -}}
{{ if (index $additionalProperties "description") -}}
May have additional properties: {{ $additionalProperties.description }}
Notes on additional properties: {{ $additionalProperties.description }}
{{ end }}
{{/* TODO: should we handle the case where additional properties are permitted,
but must follow an explicit schema? */}}
{{ else if $additionalProperties -}}
May have additional properties.
{{/* TODO: should we handle the case where additional properties are
permitted, but must follow an explicit schema? */}}
{{ else if (not $additionalProperties) -}}
{{/* At present we don't have any schema with additionalProperties: false.
But if we ever do, let's support it. */}}
{{ errorf "Unexpected additionalProperties=false for %s" $caption }}
May **not** have additional properties.
{{ end }}
</td>