-
Notifications
You must be signed in to change notification settings - Fork 61
Python SDK design for Http.File when it appears in non-multipart request body and response body (DO NOT MERGE)
#3351
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
Draft
msyyc
wants to merge
9
commits into
main
Choose a base branch
from
docs/http-file-body-compatibility
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
fd45d36
docs: clarify Http.File request body compatibility
msyyc 25971fd
docs: fix design doc wording, IO type, union syntax, and add overloads
msyyc e19f144
docs: improve design doc structure and wording
msyyc 272eb64
docs: add concrete examples to backward compatibility section
msyyc ec80958
docs: add Http.File response body section
msyyc d1535cc
docs: update Http.File request body compatibility and overview
msyyc 13a9ce4
revert: undo changes to docs/developer/readme.md
msyyc 17877e8
docs: add references to TypeSpec Http.File docs and Spector tests
msyyc 7e03176
docs: clean up title and simplify TypeSpec examples
msyyc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Python SDK design for `Http.File` when it appears in non-multipart request body and response body | ||
|
|
||
| ## Overview | ||
|
|
||
| TypeSpec `Http.File` is emitted differently depending on whether it appears as a non-multipart request body or a response body: | ||
|
|
||
| - **Request body**: emits `IO | bytes` (new pattern; Swagger `type: file` was never used in non-multipart request bodies) | ||
| - **Response body**: emits `bytes` (identical to legacy Swagger `type: file` signature) | ||
|
|
||
| Since `type: file` was not used in non-multipart request bodies, the request body change is purely additive. The response body remains fully backward compatible. | ||
|
|
||
| ## Request Body | ||
|
|
||
| ### TypeSpec Definition | ||
|
|
||
| ```typespec | ||
| @post | ||
| op upload(@body body: Http.File): void; | ||
| ``` | ||
|
|
||
| ### Generated Python SDK | ||
|
|
||
| ```python | ||
| from typing import IO, overload | ||
|
|
||
| @overload | ||
| def upload(self, body: IO, **kwargs) -> None: | ||
| ... | ||
|
|
||
| @overload | ||
| def upload(self, body: bytes, **kwargs) -> None: | ||
| ... | ||
|
|
||
| def upload(self, body: IO | bytes, **kwargs) -> None: | ||
| ... | ||
| ``` | ||
|
|
||
| ## Response Body | ||
|
|
||
| ### TypeSpec Definition | ||
|
|
||
| ```typespec | ||
| @get | ||
| op download(): Http.File; | ||
| ``` | ||
|
|
||
| ### Generated Python SDK | ||
|
|
||
| ```python | ||
| def download(self, **kwargs) -> bytes: | ||
| ... | ||
| ``` | ||
|
|
||
| ### Backward Compatibility | ||
|
|
||
| Swagger `type: file` (e.g. [`operationId: "WebApps_GetWebSiteContainerLogs"`](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/web/resource-manager/Microsoft.Web/AppService/stable/2024-11-01/WebApps.json#L2675)) responses also generated `bytes` (e.g. [`WebAppsOperations.get_web_site_container_logs(...)`](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/appservice/azure-mgmt-web/azure/mgmt/web/operations/_web_apps_operations.py#L22070)). The TypeSpec `Http.File` response emits the same `bytes` return type, so existing callers are **completely unaffected**. | ||
|
|
||
| ## References | ||
|
|
||
| - [TypeSpec `Http.File` documentation](https://typespec.io/docs/libraries/http/files/#using-httpfile-in-operations) — explains how `Http.File` works in operations (uploading, downloading, multipart payloads, custom file models, and when a model is effectively a `File`). | ||
| - [Spector test cases for `Http.File`](https://github.com/microsoft/typespec/blob/main/packages/http-specs/specs/type/file/main.tsp) — conformance tests covering file upload/download with specific, JSON, multiple, and default content types. | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This loses both content type and suggested file name. And it is a very dangerous operation for large amounts of data.