Zudoku Discussions

[ntotten]

👋 Welcome!

We’re using Discussions as a place to connect and support Zudoku users and builders. Here you can:

• Ask questions about building with Zudoku
• Share ideas for updates and improvements you'd like to see
• Use your knowledge to help other developers

We hope you'll respect others and are open-minded. You can find our Code of Conduct here.

[vengroff]

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. Is there a way to do it with zudoku?

I'm new to zudoku so I don't know if this is just a matter of editing my config file appropriately or if more code has to be written in zudoku itself to make this happen. I hunted around in the code a bit but I did not find anything obvious. But I could have missed it since I'm not familiar with the codebase yet.

[vengroff]

If this is not currently supported, should I create a feature request issue for it?

[ntotten]

This is a great feature request. We're planning on adding a bunch of enhancements around examples and the playground soon. Please do open this as an issue.

[mosch]

See: #492