OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript-nextjs] Compilation error in generated *.service.ts file for multipart file upload

Open
#13,400 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

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

When having multipart form data in schema, the generated api file has compilation error.
This is caused due a variable formParams only being initialized in if block and not in else block.

openapi-generator version

6.1.0, present in all versions

OpenAPI declaration file content or url
  /upload-file:
    post:
      tags:
        - File
      operationId: uploadFile
      summary: upload profile for user
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '200':    # status code
          description: Success response
          content:
            application/json:
              schema: 
                type: string
Generation Details
npx @openapitools/openapi-generator-cli generate -i swagger.json -g typescript-nestjs -o temp
Caused by

https://github.com/OpenAPITools/openapi-generator/blob/c59759f20a18dd2aaba9586943d99987cfd76f12/modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache#L196

Since this line is commented out, typerscript compiler gives Variable 'formParams' is used before being assigned. for this.

Related issues/PRs

None

Suggest a fix

We can either

  1. Throw an error in else block, this would calm the TS compiler.
  2. Just uncomment the line and added necessary imports.
    (I don't have enough TypeScript context to understand its usage, but simple googling suggest its somehow related to angular so might not be required)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache around line 196, then generate the provided multipart upload specification with the documented npx command. Inspect the generated api service and verify that TypeScript compilation no longer reports formParams as used before being assigned.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.