Provide all fixed field names for the components object in ResolvedComponent.* constants #1138
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
The OpenAPI components object (https://swagger.io/specification/\#components-object) is used to store schema definitions that can be referred to using the pattern, encouraging re-use. drf-spectacular only uses the 'schemas' and 'securitySchemes' properties internally, but extension developers may wish to use the remaining properties, so they are provided as a convenience. Note that the 'pathItems' property was added in OpenAPI 3.1.0.
sergei-maertens
commented
Jan 3, 2024
Comment on lines
+683
to
+694
| # OpenAPI 3.0.3 | ||
| SCHEMA = 'schemas' | ||
| RESPONSE = 'responses' | ||
| PARAMETER = 'parameters' | ||
| EXAMPLE = 'examples' | ||
| REQUEST_BODY = 'requestBodies' | ||
| HEADER = 'headers' | ||
| SECURITY_SCHEMA = 'securitySchemes' | ||
| LINK = 'links' | ||
| CALLBACK = 'callbacks' | ||
| # OpenAPI 3.1.0+ | ||
| PATH_ITEM = 'pathItems' |
There was a problem hiding this comment.
Added & documented them in the same order as the OpenAPI spec does.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1138 +/- ##
=======================================
Coverage 98.63% 98.63%
=======================================
Files 71 71
Lines 8690 8698 +8
=======================================
+ Hits 8571 8579 +8
Misses 119 119 ☔ View full report in Codecov by Sentry. |
|
awesome, thanks @sergei-maertens I think I'll add some comment later that we only use 2 natively. People kept asking about the others on occasion. |
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.
Closes #1128
The OpenAPI components object (https://swagger.io/specification/\#components-object) is used to store schema definitions that can be referred to using the
pattern, encouraging re-use. drf-spectacular only uses the
'schemas' and 'securitySchemes' properties internally, but extension developers may wish to use the remaining properties, so they are provided as a convenience.
Note that the 'pathItems' property was added in OpenAPI 3.1.0.