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

Add screen grab of Swagger docs to FastAPIWrapper page #135

Closed
dantownsend opened this issue Jan 27, 2022 · 1 comment
Closed

Add screen grab of Swagger docs to FastAPIWrapper page #135

dantownsend opened this issue Jan 27, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@dantownsend
Copy link
Member

dantownsend commented Jan 27, 2022

Having a screen grab showing the generated Swagger docs would be nice on this page:

https://piccolo-api.readthedocs.io/en/latest/fastapi/index.html

The FastAPIWrapper / PiccoloCRUD combo is one of the most powerful things in the Piccolo ecosystem, and a screen grab will make it clearer the functionality it gives you.

Screenshot 2022-01-27 at 12 05 03

That page is also unusual in that it uses Task as an example - we should change it to use Movie, as we can get example code / screen grabs from Piccolo Admin.

@dantownsend dantownsend added the documentation Improvements or additions to documentation label Jan 27, 2022
@dantownsend dantownsend changed the title Add screen grab of Swagger docs to FastAPIWrapper page Add screen grab of Swagger docs to FastAPIWrapper page Jan 27, 2022
@sinisaos
Copy link
Member

sinisaos commented Apr 2, 2023

@dantownsend You can close this issue because it's done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants