fix: "name" and "in" should not be included in openapi headers #3417
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3417 +/- ##
=======================================
Coverage 98.28% 98.28%
=======================================
Files 324 324
Lines 14774 14780 +6
Branches 2344 2346 +2
=======================================
+ Hits 14520 14526 +6
Misses 116 116
Partials 138 138 ☔ View full report in Codecov by Sentry. |
Exclude the "name" and "in" fields from openapi schema generated for headers. Add ``BaseSchemaObject._iter_fields()`` method that allows schema types to define the fields that should be included in their openapi schema representation and override that method for ``OpenAPIHeader``. Closes #3416
peterschutt
force-pushed
the
3416-openapi-excluded-header-fields
branch
from
68cbe86
to
ee4194a
Compare
|
JacobCoffee
approved these changes
Apr 23, 2024
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3417 |
4 tasks
peterschutt
added a commit
that referenced
this pull request
May 1, 2024
Exclude the "name" and "in" fields from openapi schema generated for headers. Add ``BaseSchemaObject._iter_fields()`` method that allows schema types to define the fields that should be included in their openapi schema representation and override that method for ``OpenAPIHeader``. Closes #3416 (cherry picked from commit c372633)
peterschutt
added a commit
that referenced
this pull request
May 2, 2024
Exclude the "name" and "in" fields from openapi schema generated for headers. Add ``BaseSchemaObject._iter_fields()`` method that allows schema types to define the fields that should be included in their openapi schema representation and override that method for ``OpenAPIHeader``. Closes #3416 (cherry picked from commit c372633)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Exclude the "name" and "in" fields from openapi schema generated for headers.
Add
BaseSchemaObject._iter_fields()method that allows schema types to define the fields that should be included in their openapi schema representation and override that method forOpenAPIHeader.Closes #3416
Description
Closes