Example data not showing up in API docs

rstudio / vetiver-python

Version, share, deploy, and monitor models.

https://rstudio.github.io/vetiver-python/stable/

MIT License

60 stars 18 forks source link

Example data not showing up in API docs #72

Open gsingh91 opened 2 years ago

gsingh91 commented 2 years ago

Describe the bug After publishing a vetiver API, the EXAMPLE section is not picking up data from ptype. The same data shows up in SCHEMA section though.

To Reproduce Use this API: https://colorado.rstudio.com/rsc/bike-predict-python-api/

Expected behavior Example should also be populated with default values.

Screenshots

isabelizimm commented 2 years ago

I believe this feature was lost when changing from Swagger to Rapidoc for visual API documentation (to match R + better UI. Unfortunately, it can't be changed easily with updating the openapi.json specification as anticipated.

For now, I'm adding this to the vetiver planning backlog, as I don't anticipate I will work on this more in the next 6-8 weeks. Currently you can still access the Swagger docs at {url}/docs if you prefer to use documentation with filled data.