Model attribute and its properties not visible in Swagger 3 UI

[codewanderer16]

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	2.0
Which Swagger-UI version?	3.1.7, 3.0.14
How did you install Swagger-UI?	from the download zip
Which browser & version?	several
Which operating system?	Windows 10

Demonstration API definition

example swagger.json file

Current Behavior

In the Patch Request model, expand Operations. The information for "value" is not visible.
(Occurs in the PATCH endpoint and the Models section.)

In the PATCH endpoint, the example value does not even list "value."

Expected Behavior

Full content should be displayed.

[webron]

The example doesn't list "value" because it doesn't have a type, so producing an example for it would be tricky. We could provide an example of an object/string/integer/array but no matter what we'll choose, someone will end up unhappy about it.

[hkosova]

This might be related to #3545.

[hkosova]

@webron the issue is also that the Model renderer does not render the property description.

[hkosova]

@codewanderer16, is value suppposed to have no explicit type? No type means it can be any type - string, number, object, etc.

If it's supposed to be a key/value map (dictionary) then it should be type: object with additionalProperties. https://swagger.io/docs/specification/data-models/dictionaries/

[webron]

@hkosova yeah, I was just talking about the example value. I'm aware the description is not rendered which is why I didn't just close the ticket.

[codewanderer16]

@hkosova yes, value can be any type.

For the example model, any example I choose will, of course, have a specific type. But will it be visible when value itself has no type? Not displaying it seems like a problem.

[codewanderer16]

In Swagger 2.0, the description does render:

And value is visible in the example:

[webron]

Yes, but it's rendered wrong. There's no real right way of rendering it, not sure what would be the right solution here. The best suggestion right now is for you to provide an example yourself and that would be rendered.

[webron]

Closing as this renders correctly now.