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.

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

[BUG] file uploads not supported by the Rust generator #17822

Open
2 of 6 tasks
qrilka opened this issue Feb 8, 2024 · 0 comments
Open
2 of 6 tasks

[BUG] file uploads not supported by the Rust generator #17822

qrilka opened this issue Feb 8, 2024 · 0 comments

Comments

@qrilka
Copy link

qrilka commented Feb 8, 2024

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

It's not clear how the project documents file upload support. But according to https://openapi-generator.tech/docs/generators/rust/ both File data type and FormMultipart are implemented. In practice the generated code contains just a TODO.
Side comment: file parameter becomes encoded as file: std::path::PathBuf which makes it impossible to use the generated code from WASM.

openapi-generator version
$ openapi-generator-cli --version
openapi-generator-cli 7.0.1

Also checked the latest templates in master

OpenAPI declaration file content or url
            "UploadRequest": {
                "properties": {
                    "file": {
                        "format": "binary",
                        "type": "string"
                    }
                },
                "required": [
                    "file"
                ],
                "type": "object"
            }
Generation Details

In the generated Rust code I see

    // TODO: support file upload for 'file' parameter

Reflecting the template

// TODO: support file upload for '{{{baseName}}}' parameter

Steps to reproduce

Create an endpoint with response body with "content": "multipart/form-data" and containing file parameter with format "binary", and type "string. Run Rust generator for this API spec.

Related issues/PRs

#16167

Suggest a fix

Create an explicit ticket about file support implementation and make it visible on the website that it's still missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant