Skip to content

[typescript-axios]: align jsdoc for @deprecated #21778

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

Merged
macjohnny merged 2 commits into from
Aug 21, 2025
Merged

[typescript-axios]: align jsdoc for @deprecated #21778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7d874c
refactor: simplify `description` OR `deprecated` template
scarf005 Aug 20, 2025
6ceb665
chore: update generator output
Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions modules/openapi-generator/src/main/resources/typescript-axios/modelGeneric.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,17 @@ export interface {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
{{#vars}}
{{#description}}
/**
* {{{description}}}
* {{{description}}}
{{#deprecated}}
* @deprecated
* @deprecated
{{/deprecated}}
*/
*/
{{/description}}
{{^description}}
{{#deprecated}}
/**
*
{{#deprecated}}
* @deprecated
{{/deprecated}}
*/
* @deprecated
Comment thread
macjohnny marked this conversation as resolved.
*/
{{/deprecated}}
{{/description}}
'{{baseName}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
Expand Down
20 changes: 10 additions & 10 deletions samples/client/echo_api/typescript-axios/build/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ export interface Category {
}
export interface DataQuery extends Query {
/**
* test suffix
*/
* test suffix
*/
'suffix'?: string;
/**
* Some text containing white spaces
*/
* Some text containing white spaces
*/
'text'?: string;
/**
* A date
*/
* A date
*/
'date'?: string;
}

Expand Down Expand Up @@ -81,8 +81,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}

Expand All @@ -96,8 +96,8 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum];

export interface Query {
/**
* Query
*/
* Query
*/
'id'?: number;
'outcomes'?: Array<QueryOutcomesEnum>;
}
Expand Down
12 changes: 6 additions & 6 deletions samples/client/petstore/typescript-axios/builds/default/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
Expand All @@ -71,8 +71,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}

Expand Down Expand Up @@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

Expand Down
12 changes: 6 additions & 6 deletions samples/client/petstore/typescript-axios/builds/es6-target/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
Expand All @@ -71,8 +71,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}

Expand Down Expand Up @@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

Expand Down
63 changes: 30 additions & 33 deletions samples/client/petstore/typescript-axios/builds/test-petstore/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ export interface AdditionalPropertiesClass {
'map_with_undeclared_properties_anytype_2'?: object;
'map_with_undeclared_properties_anytype_3'?: { [key: string]: any; };
/**
* an object with no declared properties and no undeclared properties, hence it\'s an empty map.
*/
* an object with no declared properties and no undeclared properties, hence it\'s an empty map.
*/
'empty_map'?: object;
'map_with_undeclared_properties_string'?: { [key: string]: string; };
}
Expand Down Expand Up @@ -81,8 +81,8 @@ export interface Capitalization {
'Capital_Snake'?: string;
'SCA_ETH_Flow_Points'?: string;
/**
* Name of the pet
*/
* Name of the pet
*/
'ATT_NAME'?: string;
}
export interface Cat extends Animal {
Expand Down Expand Up @@ -236,12 +236,12 @@ export interface FormatTest {
'uuid'?: string;
'password': string;
/**
* A string that is a 10 digit number. Can have leading zeros.
*/
* A string that is a 10 digit number. Can have leading zeros.
*/
'pattern_with_digits'?: string;
/**
* A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01.
*/
* A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01.
*/
'pattern_with_digits_and_delimiter'?: string;
}
/**
Expand Down Expand Up @@ -331,8 +331,8 @@ export interface Model200Response {
*/
export interface ModelFile {
/**
* Test capitalization
*/
* Test capitalization
*/
'sourceURI'?: string;
}
/**
Expand Down Expand Up @@ -372,19 +372,16 @@ export interface NumberOnly {
export interface ObjectWithDeprecatedFields {
'uuid'?: string;
/**
*
* @deprecated
*/
* @deprecated
*/
'id'?: number;
/**
*
* @deprecated
*/
* @deprecated
*/
'deprecatedRef'?: DeprecatedObject;
/**
*
* @deprecated
*/
* @deprecated
*/
'bars'?: Array<string>;
}
export interface Order {
Expand All @@ -393,8 +390,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
Expand Down Expand Up @@ -461,8 +458,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}

Expand Down Expand Up @@ -549,24 +546,24 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
/**
* test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value.
*/
* test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value.
*/
'objectWithNoDeclaredProps'?: object;
/**
* test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value.
*/
* test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value.
*/
'objectWithNoDeclaredPropsNullable'?: object | null;
/**
* test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See https://github.com/OAI/OpenAPI-Specification/issues/1389
*/
* test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See https://github.com/OAI/OpenAPI-Specification/issues/1389
*/
'anyTypeProp'?: any;
/**
* test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The \'nullable\' attribute does not change the allowed values.
*/
* test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The \'nullable\' attribute does not change the allowed values.
*/
'anyTypePropNullable'?: any | null;
}
export interface Whale {
Expand Down
12 changes: 6 additions & 6 deletions samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
Expand All @@ -80,8 +80,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}

Expand Down Expand Up @@ -112,8 +112,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

Expand Down
Loading
Loading