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

docs: add documentation for returns #72

Open
KreativeThinker opened this issue Feb 19, 2025 · 2 comments
Open

docs: add documentation for returns #72

KreativeThinker opened this issue Feb 19, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation easy Good for newcomers help wanted Extra attention is needed medium priority

Comments

@KreativeThinker
Copy link
Contributor

All end points require return JSON sample for documentation

@KreativeThinker KreativeThinker added documentation Improvements or additions to documentation easy Good for newcomers help wanted Extra attention is needed medium priority labels Feb 19, 2025
@adithyasunil04
Copy link

adithyasunil04 commented Feb 21, 2025

i can take up this problem
@KreativeThinker do u prefer the documentation snippet inline with functions or seperately saved in a json file?

@KreativeThinker
Copy link
Contributor Author

I have reviewed your PR and mentioned how to add the response models. You can remove the textual example and just add the respective pydantic response models to the router and that should be sufficient.

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 easy Good for newcomers help wanted Extra attention is needed medium priority
Projects
None yet
Development

No branches or pull requests

2 participants