You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In schemata for objects it is allowed to set additionalProperties to true and allow arbitrary key-value pairs. Unfortunately this is not rendered by ReDoc and users reading the rendered documentation are not aware of the fact that they can add more properties than the one specified directly in the OpenAPI specification.
Example:
openapi: 3.0.1
info:
title: Test
version: "0.1.0"
paths:
/example:
get:
summary: Example operation
description: This is a simple example.
responses:
'200':
description: This is a sample schema for a response with additionalProperties.
content:
application/json:
schema:
type: object
properties:
id:
type: number
stringProperties:
type: object
additionalProperties:
type: string
untypedProperties:
type: object
additionalProperties: true
example:
id: 123
stringProperties:
anotherProp: "test"
untypedProperties:
anotherProp: "test"
I would expect that additional properties of any type are allowed for the untypedProperties object. Should be the same way as for the stringProperties.
The text was updated successfully, but these errors were encountered:
m-mohr
changed the title
additionalProperties not rendered
"additionalProperties: true" not rendered
Aug 6, 2018
m-mohr
changed the title
"additionalProperties: true" not rendered
additionalProperties not rendered
Aug 6, 2018
In schemata for objects it is allowed to set
additionalProperties
totrue
and allow arbitrary key-value pairs. Unfortunately this is not rendered by ReDoc and users reading the rendered documentation are not aware of the fact that they can add more properties than the one specified directly in the OpenAPI specification.Example:
Rendered as: https://rebilly.github.io/ReDoc/?url=http://mamo-net.de/feature/redoc/additionalprops.yaml
I would expect that additional properties of any type are allowed for the
untypedProperties
object. Should be the same way as for thestringProperties
.The text was updated successfully, but these errors were encountered: