Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Minor API spec issue: StreamingResponseBinary is object, not binary #2871

Open
jdimeo opened this issue Jan 26, 2025 · 0 comments
Open

Minor API spec issue: StreamingResponseBinary is object, not binary #2871

jdimeo opened this issue Jan 26, 2025 · 0 comments
Assignees
@JanCizmar
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jdimeo
Copy link
Contributor

jdimeo commented Jan 26, 2025

As a follow on for #1450 , the current REST API spec has type: object for StreamingResponseBody. It's more precise and more helpful to generated API clients if it is type: binary (in which case the generated client will expect a File or Path). I encountered this when exporting a project's translations to a zip file via API.

Image
@JanCizmar JanCizmar self-assigned this Jan 27, 2025
@JanCizmar JanCizmar added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JanCizmar JanCizmar

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jdimeo @JanCizmar