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

[BUG] [typescript-axios] withSeparateModelsAndApi Bad import of interface model - missing import type #17461

Closed
4 of 5 tasks
jmorille opened this issue Dec 22, 2023 · 2 comments · Fixed by #18625
Closed
4 of 5 tasks

[BUG] [typescript-axios] withSeparateModelsAndApi Bad import of interface model - missing import type #17461

jmorille opened this issue Dec 22, 2023 · 2 comments · Fixed by #18625
Labels
Issue: Bug

Comments

@jmorille
Copy link

Bug Report Checklist

  • [X ] 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 generate open-api client with generatorName: typescript-axios, the template generate model like an interface model

export interface JmsDlqEventMessageJsonNode {
    /**
     * 
     * @type {string}
     * @memberof JmsDlqEventMessageJsonNode
     */
    'JMSMessageID'?: string;
    /**
     * 
     * @type {string}
     * @memberof JmsDlqEventMessageJsonNode
     */
    'JMSCorrelationID'?: string;

That work fine except if you are using the option withSeparateModelsAndApi=true
In this case the api class generate import without the type

 // @ts-ignore
 import { JmsDlqEventMessageJsonNode } from '../model';

but we excepted something like

 // @ts-ignore
 import type { JmsDlqEventMessageJsonNode } from '../model';

for have a working solution in runtime

openapi-generator version

openapi-generator-maven-plugin in version 7.2.0

OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix
@jmorille
Copy link
Author

Duplicat of #17462

@m1k1o
Copy link
Contributor

m1k1o commented May 9, 2024

Have the same issue, solution to this is simply:

diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache
index 7ad585b937..47c95f0e35 100644
--- a/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache
+++ b/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache
@@ -18,10 +18,10 @@ import FormData from 'form-data'
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '{{apiRelativeToRoot}}common';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '{{apiRelativeToRoot}}base';
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '{{apiRelativeToRoot}}base';
 {{#imports}}
 // @ts-ignore
-import { {{classname}} } from '{{apiRelativeToRoot}}{{tsModelPackage}}';
+import type { {{classname}} } from '{{apiRelativeToRoot}}{{tsModelPackage}}';
 {{/imports}}
 {{/withSeparateModelsAndApi}}
 {{^withSeparateModelsAndApi}}
diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/model.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/model.mustache
index 9e1e84422b..4ec53a6c40 100644
--- a/modules/openapi-generator/src/main/resources/typescript-axios/model.mustache
+++ b/modules/openapi-generator/src/main/resources/typescript-axios/model.mustache
@@ -4,13 +4,13 @@
 {{#withSeparateModelsAndApi}}{{#hasAllOf}}{{#allOf}}
 // May contain unused imports in some cases
 // @ts-ignore
-import { {{class}} } from './{{filename}}';{{/allOf}}{{/hasAllOf}}{{#hasOneOf}}{{#oneOf}}
+import type { {{class}} } from './{{filename}}';{{/allOf}}{{/hasAllOf}}{{#hasOneOf}}{{#oneOf}}
 // May contain unused imports in some cases
 // @ts-ignore
-import { {{class}} } from './{{filename}}';{{/oneOf}}{{/hasOneOf}}{{^hasAllOf}}{{^hasOneOf}}{{#imports}}
+import type { {{class}} } from './{{filename}}';{{/oneOf}}{{/hasOneOf}}{{^hasAllOf}}{{^hasOneOf}}{{#imports}}
 // May contain unused imports in some cases
 // @ts-ignore
-import { {{class}} } from './{{filename}}';{{/imports}}{{/hasOneOf}}{{/hasAllOf}}{{/withSeparateModelsAndApi}}
+import type { {{class}} } from './{{filename}}';{{/imports}}{{/hasOneOf}}{{/hasAllOf}}{{/withSeparateModelsAndApi}}
 {{#models}}{{#model}}
 {{#isEnum}}{{>modelEnum}}{{/isEnum}}{{#oneOf}}{{#-first}}{{>modelOneOf}}{{/-first}}{{/oneOf}}{{#allOf}}{{#-first}}{{>modelAllOf}}{{/-first}}{{/allOf}}{{^isEnum}}{{^oneOf}}{{^allOf}}{{>modelGeneric}}{{/allOf}}{{/oneOf}}{{/isEnum}}
 {{/model}}{{/models}}

@m1k1o m1k1o mentioned this issue May 9, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Issue: Bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

typescript-axios: withSeparateModelsAndApi - fix missing import type m1k1o/openapi-generator
2 participants
@jmorille @m1k1o