Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not use title for objects containing only additionalProperties or patternProperties #1801

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1801.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Do not use the `title` of objects containing only `additionalProperties` or `patternProperties`.
29 changes: 21 additions & 8 deletions layouts/partials/openapi/render-object-table.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@
* `oneOf`: optional array of dictionaries describing the different formats
that the property can have

* `properties`: if the type is an object, optional dictionary for
well-defined properties, each given as: `property_name` : `property_data`

* `additionalProperties`: if the type is an object, optional dictionary for
properties with undefined names

Expand Down Expand Up @@ -148,26 +151,29 @@

* `title`: optional string for the title of the object property

* `properties`: optional dictionary for well-defined properties, each given
as: `property_name` : `property_data`

* `additionalProperties`: optional dictionary for properties with undefined
names

* `patternProperties`: optional dictionary for properties with names
adhering to a regex pattern

* `anchor`: optional HTML element id for the target type, which will be used to link to it.

The title has a higher priority than anything else.
*/}}
{{ define "partials/object-type-or-title" }}
{{ $type := "object" }}
{{ if .title }}
{{ if .properties }}
{{/*
If the property has a `title`, use that rather than `type`.
This means we can write things like `EventFilter` rather than `object`.
The object has its own (regular) properties, so we will make a
separate table for it. Refer to it using its title, if it has one.
*/}}
{{ $type = .title | htmlEscape }}
{{ if .anchor }}
{{ $type = printf "<a href=\"#%s\">%s</a>" (htmlEscape .anchor) $type }}
{{ if .title }}
{{ $type = .title | htmlEscape }}
{{ if .anchor }}
{{ $type = printf "<a href=\"#%s\">%s</a>" (htmlEscape .anchor) $type }}
{{ end }}
{{ end }}
{{ else if reflect.IsMap .additionalProperties }}
{{/*
Expand Down Expand Up @@ -218,6 +224,13 @@

{{/* Then join all the formats. */}}
{{ $type = delimit $types "|" }}
{{ else if .title }}
{{/*
No properties, so there won't be a separate table. We use the title
anyway, because showing the title (like `EventFilter`) is better
than showing `object`.
*/}}
{{ $type = .title | htmlEscape }}
{{ end }}

{{ return $type }}
Expand Down