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

feat: Allow customizing schema component keys #3738

Merged
merged 6 commits into from
Sep 15, 2024

Conversation

provinzkraut
Copy link
Member

@provinzkraut provinzkraut commented Sep 14, 2024

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.


  • Add a new schema_component_key to KwargDefinition and the Body and Parameter functions
  • Add a friendly error message when keys are not unique / reused across different types

@github-actions 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 provinzkraut force-pushed the feat/schema-component-key branch from fc5dc18 to dfdd92a Compare September 14, 2024 14:14
Copy link

codecov bot commented Sep 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.29%. Comparing base (1132554) to head (7398707).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@provinzkraut provinzkraut force-pushed the feat/schema-component-key branch from 8ed0132 to 5ee9ba2 Compare September 15, 2024 08:21
@provinzkraut provinzkraut marked this pull request as ready for review September 15, 2024 08:27
@provinzkraut provinzkraut requested review from a team as code owners September 15, 2024 08:27
@provinzkraut provinzkraut enabled auto-merge (squash) September 15, 2024 09:21
@provinzkraut provinzkraut merged commit 5ed9eb0 into main Sep 15, 2024
24 checks passed
@provinzkraut provinzkraut deleted the feat/schema-component-key branch September 15, 2024 09:24
Copy link

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants