Add contentMediaType field to generated schema when format is binary #422
Conversation
This file contains hidden or 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 #422 +/- ##
==========================================
+ Coverage 92.72% 92.74% +0.02%
==========================================
Files 21 21
Lines 3546 3556 +10
==========================================
+ Hits 3288 3298 +10
Misses 220 220
Partials 38 38 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds the
contentMediaTypeproperty to the generated schema spec for binary field. This is mainly for the purpose of compatibility with API documentation tools such as Stoplight Elements (see #397).Note that #415 sets
contentTypeproperty in the schema, but that is not sufficient for Stoplight to show the file upload UI component, event though the OpenAPI spec sayscontentMediaTypeis not required whencontentTypeis defined.Although that may rather be an issue in Stoplight, in my understanding it does not hurt to add this redundancy to Huma.
Thus, this PR can be considered independently from #415. I hope I'm not mistaken about what the OpenAPI specs say, let me know if you think this rather belongs to Stoplight issues.
Example schema:
{ "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "filename": { "contentMediaType": "application/octet-stream", "description": "filename of the file being uploaded", "format": "binary", "type": "string" }, "name": { "description": "general purpose name for multipart form value", "type": "string" } }, "type": "object" } } }, "required": true }Sample UI screenshot:
