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

fix: allow for local example to override global #3666

Merged
merged 1 commit into from
Nov 17, 2022

Conversation

technovangelist
Copy link
Contributor

@technovangelist technovangelist commented Nov 17, 2022

Signed-off-by: Matt Williams m@technovangelist.com

Summary

If you set an example in a struct but an example has already been set for that type more globally, the local example won't ever be seen. this just swaps the order of setting those so that the docs can be more descriptive.

Checklist

  • Wrote appropriate unit tests
  • Considered security implications of the change
  • Updated associated docs where necessary
  • Updated associated configuration where necessary
  • Change is backwards compatible if it needs to be (user can upgrade without manual steps?)
  • Nothing sensitive logged
  • Considered data migrations for smooth upgrades

Related Issues

related to #3664

this is for generatIng openapi docs

Signed-off-by: Matt Williams <m@technovangelist.com>
@technovangelist technovangelist merged commit ffe69d9 into main Nov 17, 2022
@technovangelist technovangelist deleted the matt/openapiexampleoverride branch November 17, 2022 19:49
technovangelist added a commit that referenced this pull request Nov 18, 2022
this is for generatIng openapi docs

Signed-off-by: Matt Williams <m@technovangelist.com>

Signed-off-by: Matt Williams <m@technovangelist.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants