Support examples from the OpenAPI Spec

[vengroff]

This is a feature request originally posted in #57 (comment).

I have an OpenAPI spec that has a post endpoint with an examples section contained within the content section of the requestBody. When I look at the doc generated from this with the default zudoku.config.ts there is a box on the right where I can see sample calls in curl or a variety of languages. But all of them just pass empty lists or dictionaries to the various components of the request. All fields empty is not a valid input for this API, so it is frustrating to users that they don't see a working example.

What I would like to do is have a drop-down listing each of the examples the API spec provides with text for each choice coming from the summary field of one of the examples. When I pick one I would like to have it fill in the values in the example code from the value component of the chosen example and also render the description from the description field so the user can read it. This gives the user a known working input that they can then copy and paste or modify as they see fit. The standard docs generated by FastAPI do this for the API spec in question.

[linear]

ZUP-4012 Support examples from the OpenAPI Spec

[vengroff]

Looking forward to this. Is there a way to get some additional visibility on priority and timing? I'm guessing that's what the linear bot link above is about, but it isn't visible to me.