From 493058adab6d76d3363718d97b6d3600c2b3c091 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 23 Jul 2024 13:23:32 +0200 Subject: [PATCH] Enforce `additionalProperties: {}` instead of the equivalent `additionalProperties: true` for easier processing --- .../internal/newsfragments/1909.clarification | 2 +- .../client-server/definitions/user_identifier.yaml | 2 +- layouts/partials/openapi/render-object-table.html | 13 ++++++------- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/changelogs/internal/newsfragments/1909.clarification b/changelogs/internal/newsfragments/1909.clarification index 46c540a2..a82cb9c5 100644 --- a/changelogs/internal/newsfragments/1909.clarification +++ b/changelogs/internal/newsfragments/1909.clarification @@ -1 +1 @@ -Treat `additionalProperties: true` equivalent to `additionalProperties: {}` when rendering object tables. +Enforce `additionalProperties: {}` instead of the equivalent `additionalProperties: true` for easier processing. diff --git a/data/api/client-server/definitions/user_identifier.yaml b/data/api/client-server/definitions/user_identifier.yaml index 7e6eca9c..4511f217 100644 --- a/data/api/client-server/definitions/user_identifier.yaml +++ b/data/api/client-server/definitions/user_identifier.yaml @@ -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: {} diff --git a/layouts/partials/openapi/render-object-table.html b/layouts/partials/openapi/render-object-table.html index 66658b9c..daedfc41 100644 --- a/layouts/partials/openapi/render-object-table.html +++ b/layouts/partials/openapi/render-object-table.html @@ -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 }} <Other properties> - {{ partial "partials/property-type" $additionalProperties | safeHTML }} - {{ partial "partials/property-description" (dict "property" $additionalProperties) }} + {{ partial "partials/property-type" .additionalProperties | safeHTML }} + {{ partial "partials/property-description" (dict "property" .additionalProperties) }} {{ end }}