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

* refactor: simplify `description` OR `deprecated` template

* chore: update generator output

---------

Co-authored-by: nocontribute <>
This commit is contained in:
scarf 2025-08-21 15:50:22 +09:00 committed by GitHub
parent caf53ac6c4
commit 96b44ce727
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 128 additions and 134 deletions

View File

@ -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
*/
{{/deprecated}}
{{/description}}
'{{baseName}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};

View File

@ -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;
}
@ -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;
}
@ -96,8 +96,8 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum];
export interface Query {
/**
* Query
*/
* Query
*/
'id'?: number;
'outcomes'?: Array<QueryOutcomesEnum>;
}

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -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; };
}
@ -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 {
@ -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;
}
/**
@ -331,8 +331,8 @@ export interface Model200Response {
*/
export interface ModelFile {
/**
* Test capitalization
*/
* Test capitalization
*/
'sourceURI'?: string;
}
/**
@ -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 {
@ -393,8 +390,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -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 {

View File

@ -56,8 +56,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -112,8 +112,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -70,8 +70,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 {
@ -184,12 +184,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;
}
/**
@ -256,8 +256,8 @@ export interface Model200Response {
*/
export interface ModelFile {
/**
* Test capitalization
*/
* Test capitalization
*/
'sourceURI'?: string;
}
/**
@ -294,8 +294,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -360,9 +360,9 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
* @deprecated
*/
* pet status in the store
* @deprecated
*/
'status'?: PetStatusEnum;
}
@ -414,24 +414,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.
*/
'arbitraryObject'?: 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.
*/
'arbitraryNullableObject'?: object | null;
/**
* test code generation for any type Value can be any type - string, number, boolean, array or object.
*/
* test code generation for any type Value can be any type - string, number, boolean, array or object.
*/
'arbitraryTypeValue'?: any;
/**
* test code generation for any type Value can be any type - string, number, boolean, array, object or the \'null\' value.
*/
* test code generation for any type Value can be any type - string, number, boolean, array, object or the \'null\' value.
*/
'arbitraryNullableTypeValue'?: any | null;
}
export interface Whale {

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -51,8 +51,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -75,8 +75,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}
@ -107,8 +107,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -23,8 +23,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}

View File

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

View File

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

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -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;
}
@ -103,8 +103,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}

View File

@ -47,8 +47,8 @@ export interface Order {
'quantity'?: number;
'shipDate'?: string;
/**
* Order Status
*/
* Order Status
*/
'status'?: OrderStatusEnum;
'complete'?: boolean;
}
@ -69,8 +69,8 @@ export interface Pet {
'photoUrls': Array<string>;
'tags'?: Array<Tag>;
/**
* pet status in the store
*/
* pet status in the store
*/
'status'?: PetStatusEnum;
}
@ -99,8 +99,8 @@ export interface User {
'password'?: string;
'phone'?: string;
/**
* User Status
*/
* User Status
*/
'userStatus'?: number;
}