Repository navigation
Better rendering of example responses #64
Description
I'm using the mkdocs plugin.
When rendering the example for a response, the values of the examples array in the json schema are not used.
This
"name": { "description": "", "type": "string", "examples": ["A-DSP", "MON 1"] },
gets rendered as
"name": "string"
In my opinion it should use a value from the examples array.
A similar issue exists for enums, they get rendered as null, I think rendering one of the possible values would be better.
I guess the rendering of an array of a type and null is fixed with the latest pr, but a new release would be greatly appreciated.
Activity
jan-ldwg commentedon Mar 5, 2026
I tested it further,
examplewith just one value works as expected, but from my understandingexampleswith an array of values is the correct way since JSON schema draft 6Fix #64: use examples array and enum values in auto-generated schema …
jan-ldwg commentedon Mar 7, 2026
Thank you for the quick fix!
examplesworks as expected, however,enumstill rendersnullfor me, not the first element.RobertoPrevato commentedon Mar 7, 2026
@jan-ldwg thanks for the heads up. When I reviewed I checked this detail, but I must have done something wrong.
I'll take a look. Contributions are welcome, in case you beat me on time.- finally I used the Copilot CLI. 👀RobertoPrevato commentedon Mar 7, 2026
This is what Claude Sonnet 4.6 analyzed with the Copilot CLI:
Fix enum without explicit type rendering as null (issue #64)
RobertoPrevato commentedon Mar 7, 2026
@jan-ldwg can you please try definining a
typefor the enum in your case? When I reviewed, I reviewed the situation of enums having type defined in the schema.jan-ldwg commentedon Mar 7, 2026
You`re right, having a type defined fixes it. Thank you!
RobertoPrevato commentedon Mar 7, 2026
Thanks! in any case, I will apply the fix for the situation without type defined. I won´t release it today to PyPi, though.
Fix #64 enums without declared type (#77)