Skip to content

Commit 19a5f12

Browse files
mstefaniukmacjohnny
mstefaniuk
and
macjohnny
committed
Typescript Axios returned types and export paths fixed (#5102)
* Typescript Axiom templates fixed Templates fixed to have `withInterfaces` and `withSeparateModelsAndApi` options working combined. * Added petstore generated samples for typescript-axios * Fixing line endings * Remove unnecessary change in function signature Co-Authored-By: Esteban Gehring <[email protected]> * re-generate typescript-axios samples Co-authored-by: Esteban Gehring <[email protected]>
1 parent 45f26fe commit 19a5f12

File tree

11 files changed

+138
-138
lines changed

11 files changed

+138
-138
lines changed

‎modules/openapi-generator/src/main/resources/typescript-axios/api.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
1616
{{>apiInner}}
1717
{{/apis}}{{/apiInfo}}
1818
{{/withSeparateModelsAndApi}}{{#withSeparateModelsAndApi}}
19-
{{#apiInfo}}{{#apis}}{{#operations}}export * from './{{apiPackage}}/{{classFilename}}';
19+
{{#apiInfo}}{{#apis}}{{#operations}}export * from './{{tsApiPackage}}/{{classFilename}}';
2020
{{/operations}}{{/apis}}{{/apiInfo}}
2121
{{/withSeparateModelsAndApi}}

‎modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export const {{classname}}AxiosParamCreator = function (configuration?: Configur
7878
{{#isBasicBasic}}
7979
// http basic authentication required
8080
if (configuration && (configuration.username || configuration.password)) {
81-
localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password };
81+
localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password };
8282
}
8383
{{/isBasicBasic}}
8484
{{#isBasicBearer}}
@@ -256,7 +256,7 @@ export const {{classname}}Factory = function (configuration?: Configuration, bas
256256
* @param {*} [options] Override http request option.
257257
* @throws {RequiredError}
258258
*/
259-
{{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: any) {
259+
{{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: any): AxiosPromise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
260260
return {{classname}}Fp(configuration).{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options)(axios, basePath);
261261
},
262262
{{/operation}}
@@ -284,7 +284,7 @@ export interface {{classname}}Interface {
284284
* @throws {RequiredError}
285285
* @memberof {{classname}}Interface
286286
*/
287-
{{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: any): AxiosPromise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}{}{{/returnType}}>;
287+
{{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: any): AxiosPromise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>;
288288

289289
{{/operation}}
290290
}

‎samples/client/petstore/typescript-axios/builds/default/api.ts

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -790,7 +790,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
790790
* @param {*} [options] Override http request option.
791791
* @throws {RequiredError}
792792
*/
793-
addPet(body: Pet, options?: any) {
793+
addPet(body: Pet, options?: any): AxiosPromise<void> {
794794
return PetApiFp(configuration).addPet(body, options)(axios, basePath);
795795
},
796796
/**
@@ -801,7 +801,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
801801
* @param {*} [options] Override http request option.
802802
* @throws {RequiredError}
803803
*/
804-
deletePet(petId: number, apiKey?: string, options?: any) {
804+
deletePet(petId: number, apiKey?: string, options?: any): AxiosPromise<void> {
805805
return PetApiFp(configuration).deletePet(petId, apiKey, options)(axios, basePath);
806806
},
807807
/**
@@ -811,7 +811,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
811811
* @param {*} [options] Override http request option.
812812
* @throws {RequiredError}
813813
*/
814-
findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any) {
814+
findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise<Array<Pet>> {
815815
return PetApiFp(configuration).findPetsByStatus(status, options)(axios, basePath);
816816
},
817817
/**
@@ -821,7 +821,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
821821
* @param {*} [options] Override http request option.
822822
* @throws {RequiredError}
823823
*/
824-
findPetsByTags(tags: Array<string>, options?: any) {
824+
findPetsByTags(tags: Array<string>, options?: any): AxiosPromise<Array<Pet>> {
825825
return PetApiFp(configuration).findPetsByTags(tags, options)(axios, basePath);
826826
},
827827
/**
@@ -831,7 +831,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
831831
* @param {*} [options] Override http request option.
832832
* @throws {RequiredError}
833833
*/
834-
getPetById(petId: number, options?: any) {
834+
getPetById(petId: number, options?: any): AxiosPromise<Pet> {
835835
return PetApiFp(configuration).getPetById(petId, options)(axios, basePath);
836836
},
837837
/**
@@ -841,7 +841,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
841841
* @param {*} [options] Override http request option.
842842
* @throws {RequiredError}
843843
*/
844-
updatePet(body: Pet, options?: any) {
844+
updatePet(body: Pet, options?: any): AxiosPromise<void> {
845845
return PetApiFp(configuration).updatePet(body, options)(axios, basePath);
846846
},
847847
/**
@@ -853,7 +853,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
853853
* @param {*} [options] Override http request option.
854854
* @throws {RequiredError}
855855
*/
856-
updatePetWithForm(petId: number, name?: string, status?: string, options?: any) {
856+
updatePetWithForm(petId: number, name?: string, status?: string, options?: any): AxiosPromise<void> {
857857
return PetApiFp(configuration).updatePetWithForm(petId, name, status, options)(axios, basePath);
858858
},
859859
/**
@@ -865,7 +865,7 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?:
865865
* @param {*} [options] Override http request option.
866866
* @throws {RequiredError}
867867
*/
868-
uploadFile(petId: number, additionalMetadata?: string, file?: any, options?: any) {
868+
uploadFile(petId: number, additionalMetadata?: string, file?: any, options?: any): AxiosPromise<ApiResponse> {
869869
return PetApiFp(configuration).uploadFile(petId, additionalMetadata, file, options)(axios, basePath);
870870
},
871871
};
@@ -1213,7 +1213,7 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath
12131213
* @param {*} [options] Override http request option.
12141214
* @throws {RequiredError}
12151215
*/
1216-
deleteOrder(orderId: string, options?: any) {
1216+
deleteOrder(orderId: string, options?: any): AxiosPromise<void> {
12171217
return StoreApiFp(configuration).deleteOrder(orderId, options)(axios, basePath);
12181218
},
12191219
/**
@@ -1222,7 +1222,7 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath
12221222
* @param {*} [options] Override http request option.
12231223
* @throws {RequiredError}
12241224
*/
1225-
getInventory(options?: any) {
1225+
getInventory(options?: any): AxiosPromise<{ [key: string]: number; }> {
12261226
return StoreApiFp(configuration).getInventory(options)(axios, basePath);
12271227
},
12281228
/**
@@ -1232,7 +1232,7 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath
12321232
* @param {*} [options] Override http request option.
12331233
* @throws {RequiredError}
12341234
*/
1235-
getOrderById(orderId: number, options?: any) {
1235+
getOrderById(orderId: number, options?: any): AxiosPromise<Order> {
12361236
return StoreApiFp(configuration).getOrderById(orderId, options)(axios, basePath);
12371237
},
12381238
/**
@@ -1242,7 +1242,7 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath
12421242
* @param {*} [options] Override http request option.
12431243
* @throws {RequiredError}
12441244
*/
1245-
placeOrder(body: Order, options?: any) {
1245+
placeOrder(body: Order, options?: any): AxiosPromise<Order> {
12461246
return StoreApiFp(configuration).placeOrder(body, options)(axios, basePath);
12471247
},
12481248
};
@@ -1753,7 +1753,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
17531753
* @param {*} [options] Override http request option.
17541754
* @throws {RequiredError}
17551755
*/
1756-
createUser(body: User, options?: any) {
1756+
createUser(body: User, options?: any): AxiosPromise<void> {
17571757
return UserApiFp(configuration).createUser(body, options)(axios, basePath);
17581758
},
17591759
/**
@@ -1763,7 +1763,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
17631763
* @param {*} [options] Override http request option.
17641764
* @throws {RequiredError}
17651765
*/
1766-
createUsersWithArrayInput(body: Array<User>, options?: any) {
1766+
createUsersWithArrayInput(body: Array<User>, options?: any): AxiosPromise<void> {
17671767
return UserApiFp(configuration).createUsersWithArrayInput(body, options)(axios, basePath);
17681768
},
17691769
/**
@@ -1773,7 +1773,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
17731773
* @param {*} [options] Override http request option.
17741774
* @throws {RequiredError}
17751775
*/
1776-
createUsersWithListInput(body: Array<User>, options?: any) {
1776+
createUsersWithListInput(body: Array<User>, options?: any): AxiosPromise<void> {
17771777
return UserApiFp(configuration).createUsersWithListInput(body, options)(axios, basePath);
17781778
},
17791779
/**
@@ -1783,7 +1783,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
17831783
* @param {*} [options] Override http request option.
17841784
* @throws {RequiredError}
17851785
*/
1786-
deleteUser(username: string, options?: any) {
1786+
deleteUser(username: string, options?: any): AxiosPromise<void> {
17871787
return UserApiFp(configuration).deleteUser(username, options)(axios, basePath);
17881788
},
17891789
/**
@@ -1793,7 +1793,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
17931793
* @param {*} [options] Override http request option.
17941794
* @throws {RequiredError}
17951795
*/
1796-
getUserByName(username: string, options?: any) {
1796+
getUserByName(username: string, options?: any): AxiosPromise<User> {
17971797
return UserApiFp(configuration).getUserByName(username, options)(axios, basePath);
17981798
},
17991799
/**
@@ -1804,7 +1804,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
18041804
* @param {*} [options] Override http request option.
18051805
* @throws {RequiredError}
18061806
*/
1807-
loginUser(username: string, password: string, options?: any) {
1807+
loginUser(username: string, password: string, options?: any): AxiosPromise<string> {
18081808
return UserApiFp(configuration).loginUser(username, password, options)(axios, basePath);
18091809
},
18101810
/**
@@ -1813,7 +1813,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
18131813
* @param {*} [options] Override http request option.
18141814
* @throws {RequiredError}
18151815
*/
1816-
logoutUser(options?: any) {
1816+
logoutUser(options?: any): AxiosPromise<void> {
18171817
return UserApiFp(configuration).logoutUser(options)(axios, basePath);
18181818
},
18191819
/**
@@ -1824,7 +1824,7 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
18241824
* @param {*} [options] Override http request option.
18251825
* @throws {RequiredError}
18261826
*/
1827-
updateUser(username: string, body: User, options?: any) {
1827+
updateUser(username: string, body: User, options?: any): AxiosPromise<void> {
18281828
return UserApiFp(configuration).updateUser(username, body, options)(axios, basePath);
18291829
},
18301830
};

0 commit comments

Comments
 (0)