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

Enforce additionalProperties: {} instead of the equivalent additionalProperties: true for easier processing

Browse source
This commit is contained in:
Johannes Marbach 2024-07-23 13:23:32 +02:00
parent c0e5699c16
commit 493058adab
3 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/internal/newsfragments/1909.clarification
View file

@ -1 +1 @@
Treat `additionalProperties: true` equivalent to `additionalProperties: {}` when rendering object tables.
Enforce `additionalProperties: {}` instead of the equivalent `additionalProperties: true` for easier processing.

2
data/api/client-server/definitions/user_identifier.yaml
View file

@ -21,4 +21,4 @@ properties:
description: The type of identification. See [Identifier types](/client-server-api/#identifier-types) for supported values and additional property descriptions.
required:
- type
additionalProperties: true
additionalProperties: {}

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

@ -68,17 +68,16 @@
TODO: support `patternProperties` here.
*/}}
{{/* Map `additionalProperties: true` to the equivalent `additionalProperties: {}` */}}
{{ $additionalProperties := .additionalProperties }}
{{ if eq $additionalProperties true }}
{{ $additionalProperties = dict }}
{{/* Enforce `additionalProperties: {}` instead of the equivalent `additionalProperties: true` for easier processing */}}
{{ if eq .additionalProperties true }}
{{ errorf "Use `additionalProperties: {}` instead of `additionalProperties: true`" }}
{{ end }}
{{ if reflect.IsMap $additionalProperties }}
{{ if reflect.IsMap .additionalProperties }}
<tr>
<td>&lt;Other properties&gt;</td>
<td><code>{{ partial "partials/property-type" $additionalProperties | safeHTML }}</code></td>
<td>{{ partial "partials/property-description" (dict "property" $additionalProperties) }}</td>
<td><code>{{ partial "partials/property-type" .additionalProperties | safeHTML }}</code></td>
<td>{{ partial "partials/property-description" (dict "property" .additionalProperties) }}</td>
</tr>
{{ end }}
</table>