Generate OpenAPI documentation for FromFiles and FromText parameters#652
Draft
Generate OpenAPI documentation for FromFiles and FromText parameters#652
Conversation
Co-authored-by: RobertoPrevato <2576032+RobertoPrevato@users.noreply.github.com>
Co-authored-by: RobertoPrevato <2576032+RobertoPrevato@users.noreply.github.com>
Co-authored-by: RobertoPrevato <2576032+RobertoPrevato@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix issue 546 with user feedback processing
Generate OpenAPI documentation for FromFiles and FromText parameters
Jan 31, 2026
Member
|
This is a great start! However, I would like something more. I would like to support defining custom # In the framework:
class FromMultipart:
...
class MultipartBinder(BodyBinder):
"""This class allows to define complex objects to be received as multipart form data"""
handle = FromMultipartFormData
@property
def content_type(self) -> str:
return "multipart/form-data"
... # binding logic
# User defined example:
class Address:
street: str
city: str
class ExampleClass:
id: UUID
addresses: list[Address]
profile_image: bytes
@app.router.post("/upload")
async def create_item(data: FromMultipart[ExampleClass]):
# data.value.id is UUID
# data.value.addresses is a list of Address
# data.value.profile_image is a bytes array containing the image
return 'ok'Would generate the following OpenAPI Specification: requestBody:
content:
multipart/form-data: # Media type
schema: # Request payload
type: object
properties: # Request parts
id: # Part 1 (string value)
type: string
format: uuid
address: # Part2 (object)
type: object
properties:
street:
type: string
city:
type: string
profileImage: # Part 3 (an image)
type: string
format: binary |
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
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.
FromFilesandFromTextparameters were not generating any request body documentation in OpenAPI/Swagger, making file upload endpoints invisible in the documentation UI.Changes
blacksheep/server/openapi/v3.py
_get_files_binder()to detectFilesBinderin handlersget_request_body()to generate multipart/form-data schema whenFilesBinderis present without aBodyBindertype: arraywithformat: binaryitems for file uploadstests/test_openapi_v3.py
test_handles_from_files_multipart_docs()test_handles_from_text_docs()Example
Previously, this endpoint generated no request body documentation:
Now generates:
The file upload form now renders correctly in Swagger UI.
Original prompt
Created from Copilot CLI via the copilot delegate command.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.