-
-
Notifications
You must be signed in to change notification settings - Fork 390
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
feat: Allow customizing schema component keys #3738
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area/openapi
This PR involves changes to the OpenAPI schema
area/params
This PR involves changes to the params
area/private-api
This PR involves changes to the privatized API
size: small
type/feat
pr/internal
labels
Sep 14, 2024
provinzkraut
force-pushed
the
feat/schema-component-key
branch
from
September 14, 2024 14:14
fc5dc18
to
dfdd92a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3738 +/- ##
=======================================
Coverage 98.29% 98.29%
=======================================
Files 330 330
Lines 15120 15139 +19
Branches 2400 2405 +5
=======================================
+ Hits 14862 14881 +19
Misses 117 117
Partials 141 141 ☔ View full report in Codecov by Sentry. |
provinzkraut
force-pushed
the
feat/schema-component-key
branch
from
September 15, 2024 08:21
8ed0132
to
5ee9ba2
Compare
provinzkraut
commented
Sep 15, 2024
Alc-Alc
approved these changes
Sep 15, 2024
Quality Gate passedIssues Measures |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area/openapi
This PR involves changes to the OpenAPI schema
area/params
This PR involves changes to the params
area/private-api
This PR involves changes to the privatized API
pr/internal
size: small
type/feat
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow customizing the schema key used for a component in the OpenAPI schema. The motivation is to give the user an escape hatch when we inevitably generate some less than pretty looking names for deeply nested types for the sake of uniqueness.
These supplied key are enforced to be unique, and it is checked that they won't be reused across different types.
schema_component_key
toKwargDefinition
and theBody
andParameter
functions