Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example data not showing up in API docs #72

Open
gsingh91 opened this issue Jun 28, 2022 · 1 comment
Open

Example data not showing up in API docs #72

gsingh91 opened this issue Jun 28, 2022 · 1 comment
Labels
deploy enhancement New feature or request

Comments

@gsingh91
Copy link
Contributor

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
image

@isabelizimm
Copy link
Contributor

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.

@isabelizimm isabelizimm added deploy enhancement New feature or request labels Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy enhancement New feature or request
Projects
Development

No branches or pull requests

2 participants