Skip to content

fix: resolve FastAPI deprecation warning for example fields #8203

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

Merged
merged 3 commits into from
Jul 8, 2025

Conversation

emmanuel-ferdman
Copy link
Contributor

Summary

This small PR resolves deprecation warnings for the example parameter in FastAPI's Body objects, replacing it with the recommended examples parameter. These warnings are visible in the CI logs:

/home/runner/work/InvokeAI/InvokeAI/invokeai/app/api_app.py:18: DeprecationWarning: `example` has been deprecated, please use `examples` instead

Related Issues / Discussions

QA Instructions

Merge Plan

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Tests added / updated (if applicable)
  • Documentation added / updated (if applicable)
  • Updated What's New copy (if doing a release after this PR)

@jazzhaiku
Copy link
Contributor

jazzhaiku commented Jul 6, 2025

@emmanuel-ferdman
Thanks for the contribution!
Run make frontend-typegen and commit the changes to fix the build error.

@github-actions github-actions bot added the frontend PRs that change frontend files label Jul 7, 2025
@psychedelicious psychedelicious merged commit db6af13 into invoke-ai:main Jul 8, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api frontend PRs that change frontend files python PRs that change python files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants