OpenAPITools / OpenAPITools/openapi-generator

[BUG] [typescript] Importing non-existent file

Open
#22,276 4 comments 1 reaction 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?
  • 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

the generated typescript code imports a non-existent file:

import { Null } from '../models/Null';   // <<<<< this file does not exist. generator verion 7.16 doesn't generate this line.
import { HttpFile } from '../http/http';

export class SuccRspNoneType {
    'status': SuccRspNoneTypeStatusEnum;
    'data': Null;

    static readonly discriminator: string | undefined = undefined;

    static readonly mapping: {[index: string]: string} | undefined = undefined;

    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
        {
            "name": "status",
            "baseName": "status",
            "type": "SuccRspNoneTypeStatusEnum",
            "format": ""
        },
        {
            "name": "data",
            "baseName": "data",
            "type": "Null",
            "format": ""
        }    ];

    static getAttributeTypeMap() {
        return SuccRspNoneType.attributeTypeMap;
    }

    public constructor() {
    }
}

export enum SuccRspNoneTypeStatusEnum {
    Ok = 'ok'
}


openapi-generator version

7.17.0

OpenAPI declaration file content or url
[...]
"SuccRsp_NoneType_": {
  "properties": {
    "status": {
      "const": "ok",
      "title": "Status",
      "type": "string"
    },
    "data": {
      "title": "Data",         
      "type": "null" 
    }
  },        
  "required": [
    "status",
    "data"
  ],
  "title": "SuccRsp[NoneType]",
  "type": "object"
},
[...]
Steps to reproduce

openapi-generator-cli generate -g typescript -i openapi.json -o typescript/sdk

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 by running openapi-generator-cli generate with the reported TypeScript generator, openapi.json input, and typescript/sdk output. Trace how the schema's null-typed data property becomes the generated import, then verify the generated SDK contains no import for a non-existent Null model.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.