OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript/angular] Configuration collision with api

Open
#3,074 4 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

Description

We have an API which defines a "Configuration" model. So the API generator generates an interface "Configuration" and exports this model in the "model.ts" via "export * from "./configuration".
This collides with the "index.ts" where the "Configuration" class is also exported via "export * from "./configuration".

openapi-generator version

Version 4.0.0

Suggest a fix

My current solution for this is adding a model-suffix, which renames the "Configuration" model interface to "ConfigurationModel". But I find it rather ugly. I would prefer an prefixed name for the generated "Configuration" class.

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 examining the generated model.ts and index.ts exports in the TypeScript/Angular output, using an API schema that defines a Configuration model. Confirm that the generated interface and Configuration class collide, then ensure the generated names or exports no longer conflict while preserving the model export.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
api, 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.