loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-07-03 22:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

add @summary tag to ts client (#6052)

Browse Source
This commit is contained in:
wing328 2017-07-14 13:10:36 +08:00 committed by GitHub
parent fdaf8ea65f
commit ba704e3ac8
15 changed files with 740 additions and 718 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
modules/swagger-codegen/src/main/resources/TypeScript-Fetch/api.mustache
View File

@ -72,10 +72,14 @@ export type {{{enumName}}} = {{#allowableValues}}{{#values}}"{{{.}}}"{{^-last}}
*/
export const {{classname}}FetchParamCreator = {
{{#operation}}
/** {{#summary}}
* {{summary}}{{/summary}}{{#notes}}
* {{notes}}{{/notes}}{{#allParams}}
* @param {{paramName}} {{description}}{{/allParams}}
/**
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}
* @param {{paramName}} {{description}}
{{/allParams}}
*/
{{nickname}}({{#hasParams}}params: { {{#allParams}} "{{paramName}}"{{^required}}?{{/required}}: {{{dataType}}};{{/allParams}} }, {{/hasParams}}options?: any): FetchArgs {
{{#allParams}}
@ -137,10 +141,14 @@ export const {{classname}}FetchParamCreator = {
*/
export const {{classname}}Fp = {
{{#operation}}
/** {{#summary}}
* {{summary}}{{/summary}}{{#notes}}
* {{notes}}{{/notes}}{{#allParams}}
* @param {{paramName}} {{description}}{{/allParams}}
/**
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}
* @param {{paramName}} {{description}}
{{/allParams}}
*/
{{nickname}}({{#hasParams}}params: { {{#allParams}}"{{paramName}}"{{^required}}?{{/required}}: {{{dataType}}}; {{/allParams}} }, {{/hasParams}}options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}any{{/returnType}}> {
const fetchArgs = {{classname}}FetchParamCreator.{{nickname}}({{#hasParams}}params, {{/hasParams}}options);
@ -163,10 +171,14 @@ export const {{classname}}Fp = {
*/
export class {{classname}} extends BaseAPI {
{{#operation}}
/** {{#summary}}
* {{summary}}{{/summary}}{{#notes}}
* {{notes}}{{/notes}}{{#allParams}}
* @param {{paramName}} {{description}}{{/allParams}}
/**
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}
* @param {{paramName}} {{description}}
{{/allParams}}
*/
{{nickname}}({{#hasParams}}params: { {{#allParams}} "{{paramName}}"{{^required}}?{{/required}}: {{{dataType}}};{{/allParams}} }, {{/hasParams}}options?: any) {
return {{classname}}Fp.{{nickname}}({{#hasParams}}params, {{/hasParams}}options)(this.fetch, this.basePath);
@ -181,10 +193,14 @@ export class {{classname}} extends BaseAPI {
export const {{classname}}Factory = function (fetch?: FetchAPI, basePath?: string) {
return {
{{#operation}}
/** {{#summary}}
* {{summary}}{{/summary}}{{#notes}}
* {{notes}}{{/notes}}{{#allParams}}
* @param {{paramName}} {{description}}{{/allParams}}
/**
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}
* @param {{paramName}} {{description}}
{{/allParams}}
*/
{{nickname}}({{#hasParams}}params: { {{#allParams}} "{{paramName}}"{{^required}}?{{/required}}: {{{dataType}}};{{/allParams}} }, {{/hasParams}}options?: any) {
return {{classname}}Fp.{{nickname}}({{#hasParams}}params, {{/hasParams}}options)(fetch, basePath);

10
modules/swagger-codegen/src/main/resources/typescript-angular/api.mustache
View File

@ -23,10 +23,12 @@ export class {{classname}} {
{{#operation}}
/**
* {{summary}}
* {{notes}}
{{#allParams}}* @param {{paramName}} {{description}}
{{/allParams}}*/
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}* @param {{paramName}} {{description}}
{{/allParams}}*/
public {{nickname}} ({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}extraHttpRequestParams?: any ) : ng.IHttpPromise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}{}{{/returnType}}> {
const localVarPath = this.basePath + '{{{path}}}'{{#pathParams}}
.replace('{' + '{{baseName}}' + '}', String({{paramName}})){{/pathParams}};

2
modules/swagger-codegen/src/main/resources/typescript-angular2/api.mustache
View File

@ -46,7 +46,7 @@ export class {{classname}} {
{{#operation}}
/**
* {{notes}}
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}

6
modules/swagger-codegen/src/main/resources/typescript-jquery/api.mustache
View File

@ -178,8 +178,10 @@ export class {{classname}} {
{{#operation}}
/**
* {{summary}}
* {{notes}}
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}* @param {{paramName}} {{description}}
{{/allParams}}*/
public {{nickname}} ({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) : JQueryPromise<{ response: JQueryXHR; {{#returnType}}body: {{{returnType}}}; {{/returnType}}{{^returnType}}body?: any; {{/returnType}} }> {

6
modules/swagger-codegen/src/main/resources/typescript-node/api.mustache
View File

@ -197,8 +197,10 @@ export class {{classname}} {
{{/authMethods}}
{{#operation}}
/**
* {{summary}}
* {{notes}}
* {{&notes}}
{{#summary}}
* @summary {{&summary}}
{{/summary}}
{{#allParams}}* @param {{paramName}} {{description}}
{{/allParams}}*/
public {{nickname}} ({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) : Promise<{ response: http.{{#supportsES6}}IncomingMessage{{/supportsES6}}{{^supportsES6}}ClientResponse{{/supportsES6}}; {{#returnType}}body: {{{returnType}}}; {{/returnType}}{{^returnType}}body?: any; {{/returnType}} }> {

74
samples/client/petstore/typescript-angular/api/PetApi.ts
View File

@ -27,10 +27,10 @@ export class PetApi {
}
/**
* Add a new pet to the store
*
* @param body Pet object that needs to be added to the store
*/
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
public addPet (body?: models.Pet, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/pet';
@ -51,11 +51,11 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* Deletes a pet
*
* @param petId Pet id to delete
* @param apiKey
*/
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
public deletePet (petId: number, apiKey?: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/pet/{petId}'
.replace('{' + 'petId' + '}', String(petId));
@ -82,10 +82,10 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @param status Status values that need to be considered for filter
*/
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
public findPetsByStatus (status?: Array<string>, extraHttpRequestParams?: any ) : ng.IHttpPromise<Array<models.Pet>> {
const localVarPath = this.basePath + '/pet/findByStatus';
@ -109,10 +109,10 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @param tags Tags to filter by
*/
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
public findPetsByTags (tags?: Array<string>, extraHttpRequestParams?: any ) : ng.IHttpPromise<Array<models.Pet>> {
const localVarPath = this.basePath + '/pet/findByTags';
@ -136,10 +136,10 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* @param petId ID of pet that needs to be fetched
*/
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
public getPetById (petId: number, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.Pet> {
const localVarPath = this.basePath + '/pet/{petId}'
.replace('{' + 'petId' + '}', String(petId));
@ -164,10 +164,10 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* Update an existing pet
*
* @param body Pet object that needs to be added to the store
*/
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
public updatePet (body?: models.Pet, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/pet';
@ -188,12 +188,12 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* Updates a pet in the store with form data
*
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
*/
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
*/
public updatePetWithForm (petId: string, name?: string, status?: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/pet/{petId}'
.replace('{' + 'petId' + '}', String(petId));
@ -227,12 +227,12 @@ export class PetApi {
return this.$http(httpRequestParams);
}
/**
* uploads an image
*
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
*/
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
*/
public uploadFile (petId: number, additionalMetadata?: string, file?: any, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/pet/{petId}/uploadImage'
.replace('{' + 'petId' + '}', String(petId));

30
samples/client/petstore/typescript-angular/api/StoreApi.ts
View File

@ -27,10 +27,10 @@ export class StoreApi {
}
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* @param orderId ID of the order that needs to be deleted
*/
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
public deleteOrder (orderId: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/store/order/{orderId}'
.replace('{' + 'orderId' + '}', String(orderId));
@ -55,9 +55,9 @@ export class StoreApi {
return this.$http(httpRequestParams);
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
*/
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
public getInventory (extraHttpRequestParams?: any ) : ng.IHttpPromise<{ [key: string]: number; }> {
const localVarPath = this.basePath + '/store/inventory';
@ -77,10 +77,10 @@ export class StoreApi {
return this.$http(httpRequestParams);
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* @param orderId ID of pet that needs to be fetched
*/
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
public getOrderById (orderId: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.Order> {
const localVarPath = this.basePath + '/store/order/{orderId}'
.replace('{' + 'orderId' + '}', String(orderId));
@ -105,10 +105,10 @@ export class StoreApi {
return this.$http(httpRequestParams);
}
/**
* Place an order for a pet
*
* @param body order placed for purchasing the pet
*/
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
public placeOrder (body?: models.Order, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.Order> {
const localVarPath = this.basePath + '/store/order';

66
samples/client/petstore/typescript-angular/api/UserApi.ts
View File

@ -27,10 +27,10 @@ export class UserApi {
}
/**
* Create user
* This can only be done by the logged in user.
* @param body Created user object
*/
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
public createUser (body?: models.User, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/user';
@ -51,10 +51,10 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Creates list of users with given input array
*
* @param body List of user object
*/
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithArrayInput (body?: Array<models.User>, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/user/createWithArray';
@ -75,10 +75,10 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Creates list of users with given input array
*
* @param body List of user object
*/
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithListInput (body?: Array<models.User>, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/user/createWithList';
@ -99,10 +99,10 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Delete user
* This can only be done by the logged in user.
* @param username The name that needs to be deleted
*/
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
public deleteUser (username: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/user/{username}'
.replace('{' + 'username' + '}', String(username));
@ -127,10 +127,10 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Get user by user name
*
* @param username The name that needs to be fetched. Use user1 for testing.
*/
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
public getUserByName (username: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<models.User> {
const localVarPath = this.basePath + '/user/{username}'
.replace('{' + 'username' + '}', String(username));
@ -155,11 +155,11 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Logs user into the system
*
* @param username The user name for login
* @param password The password for login in clear text
*/
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
public loginUser (username?: string, password?: string, extraHttpRequestParams?: any ) : ng.IHttpPromise<string> {
const localVarPath = this.basePath + '/user/login';
@ -187,9 +187,9 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Logs out current logged in user session
*
*/
*
* @summary Logs out current logged in user session
*/
public logoutUser (extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/user/logout';
@ -209,11 +209,11 @@ export class UserApi {
return this.$http(httpRequestParams);
}
/**
* Updated user
* This can only be done by the logged in user.
* @param username name that need to be deleted
* @param body Updated user object
*/
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
public updateUser (username: string, body?: models.User, extraHttpRequestParams?: any ) : ng.IHttpPromise<{}> {
const localVarPath = this.basePath + '/user/{username}'
.replace('{' + 'username' + '}', String(username));

184
samples/client/petstore/typescript-fetch/builds/default/api.ts
View File

@ -93,8 +93,8 @@ export interface User {
*/
export const PetApiFetchParamCreator = {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any): FetchArgs {
@ -116,8 +116,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -141,8 +141,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any): FetchArgs {
@ -163,8 +163,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any): FetchArgs {
@ -185,8 +185,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any): FetchArgs {
@ -209,8 +209,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any): FetchArgs {
@ -232,8 +232,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -263,8 +263,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -300,8 +300,8 @@ export const PetApiFetchParamCreator = {
*/
export const PetApiFp = {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -317,8 +317,8 @@ export const PetApiFp = {
};
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -335,8 +335,8 @@ export const PetApiFp = {
};
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<Pet>> {
@ -352,8 +352,8 @@ export const PetApiFp = {
};
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<Pet>> {
@ -369,8 +369,8 @@ export const PetApiFp = {
};
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Pet> {
@ -386,8 +386,8 @@ export const PetApiFp = {
};
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -403,8 +403,8 @@ export const PetApiFp = {
};
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -422,8 +422,8 @@ export const PetApiFp = {
};
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -447,16 +447,16 @@ export const PetApiFp = {
*/
export class PetApi extends BaseAPI {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.addPet(params, options)(this.fetch, this.basePath);
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -464,40 +464,40 @@ export class PetApi extends BaseAPI {
return PetApiFp.deletePet(params, options)(this.fetch, this.basePath);
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByStatus(params, options)(this.fetch, this.basePath);
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByTags(params, options)(this.fetch, this.basePath);
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any) {
return PetApiFp.getPetById(params, options)(this.fetch, this.basePath);
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.updatePet(params, options)(this.fetch, this.basePath);
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -506,8 +506,8 @@ export class PetApi extends BaseAPI {
return PetApiFp.updatePetWithForm(params, options)(this.fetch, this.basePath);
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -523,16 +523,16 @@ export class PetApi extends BaseAPI {
export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.addPet(params, options)(fetch, basePath);
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -540,40 +540,40 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return PetApiFp.deletePet(params, options)(fetch, basePath);
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByStatus(params, options)(fetch, basePath);
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByTags(params, options)(fetch, basePath);
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any) {
return PetApiFp.getPetById(params, options)(fetch, basePath);
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.updatePet(params, options)(fetch, basePath);
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -582,8 +582,8 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return PetApiFp.updatePetWithForm(params, options)(fetch, basePath);
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -600,8 +600,8 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
*/
export const StoreApiFetchParamCreator = {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any): FetchArgs {
@ -624,8 +624,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any): FetchArgs {
const baseUrl = `/store/inventory`;
@ -642,8 +642,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any): FetchArgs {
@ -666,8 +666,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any): FetchArgs {
@ -695,8 +695,8 @@ export const StoreApiFetchParamCreator = {
*/
export const StoreApiFp = {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -712,8 +712,8 @@ export const StoreApiFp = {
};
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<{ [key: string]: number; }> {
const fetchArgs = StoreApiFetchParamCreator.getInventory(options);
@ -728,8 +728,8 @@ export const StoreApiFp = {
};
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Order> {
@ -745,8 +745,8 @@ export const StoreApiFp = {
};
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Order> {
@ -768,31 +768,31 @@ export const StoreApiFp = {
*/
export class StoreApi extends BaseAPI {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any) {
return StoreApiFp.deleteOrder(params, options)(this.fetch, this.basePath);
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any) {
return StoreApiFp.getInventory(options)(this.fetch, this.basePath);
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any) {
return StoreApiFp.getOrderById(params, options)(this.fetch, this.basePath);
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any) {
@ -806,31 +806,31 @@ export class StoreApi extends BaseAPI {
export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any) {
return StoreApiFp.deleteOrder(params, options)(fetch, basePath);
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any) {
return StoreApiFp.getInventory(options)(fetch, basePath);
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any) {
return StoreApiFp.getOrderById(params, options)(fetch, basePath);
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any) {
@ -845,8 +845,8 @@ export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) {
*/
export const UserApiFetchParamCreator = {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any): FetchArgs {
@ -868,8 +868,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any): FetchArgs {
@ -891,8 +891,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any): FetchArgs {
@ -914,8 +914,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any): FetchArgs {
@ -938,8 +938,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any): FetchArgs {
@ -962,8 +962,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -986,8 +986,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any): FetchArgs {
const baseUrl = `/user/logout`;
@ -1004,8 +1004,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1039,8 +1039,8 @@ export const UserApiFetchParamCreator = {
*/
export const UserApiFp = {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1056,8 +1056,8 @@ export const UserApiFp = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1073,8 +1073,8 @@ export const UserApiFp = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1090,8 +1090,8 @@ export const UserApiFp = {
};
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1107,8 +1107,8 @@ export const UserApiFp = {
};
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<User> {
@ -1124,8 +1124,8 @@ export const UserApiFp = {
};
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1142,8 +1142,8 @@ export const UserApiFp = {
};
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
const fetchArgs = UserApiFetchParamCreator.logoutUser(options);
@ -1158,8 +1158,8 @@ export const UserApiFp = {
};
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1182,48 +1182,48 @@ export const UserApiFp = {
*/
export class UserApi extends BaseAPI {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any) {
return UserApiFp.createUser(params, options)(this.fetch, this.basePath);
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithArrayInput(params, options)(this.fetch, this.basePath);
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithListInput(params, options)(this.fetch, this.basePath);
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any) {
return UserApiFp.deleteUser(params, options)(this.fetch, this.basePath);
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any) {
return UserApiFp.getUserByName(params, options)(this.fetch, this.basePath);
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1231,15 +1231,15 @@ export class UserApi extends BaseAPI {
return UserApiFp.loginUser(params, options)(this.fetch, this.basePath);
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any) {
return UserApiFp.logoutUser(options)(this.fetch, this.basePath);
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1254,48 +1254,48 @@ export class UserApi extends BaseAPI {
export const UserApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any) {
return UserApiFp.createUser(params, options)(fetch, basePath);
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithArrayInput(params, options)(fetch, basePath);
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithListInput(params, options)(fetch, basePath);
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any) {
return UserApiFp.deleteUser(params, options)(fetch, basePath);
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any) {
return UserApiFp.getUserByName(params, options)(fetch, basePath);
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1303,15 +1303,15 @@ export const UserApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return UserApiFp.loginUser(params, options)(fetch, basePath);
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any) {
return UserApiFp.logoutUser(options)(fetch, basePath);
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/

184
samples/client/petstore/typescript-fetch/builds/es6-target/api.ts
View File

@ -92,8 +92,8 @@ export interface User {
*/
export const PetApiFetchParamCreator = {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any): FetchArgs {
@ -115,8 +115,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -140,8 +140,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any): FetchArgs {
@ -162,8 +162,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any): FetchArgs {
@ -184,8 +184,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any): FetchArgs {
@ -208,8 +208,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any): FetchArgs {
@ -231,8 +231,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -262,8 +262,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -299,8 +299,8 @@ export const PetApiFetchParamCreator = {
*/
export const PetApiFp = {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -316,8 +316,8 @@ export const PetApiFp = {
};
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -334,8 +334,8 @@ export const PetApiFp = {
};
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<Pet>> {
@ -351,8 +351,8 @@ export const PetApiFp = {
};
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<Pet>> {
@ -368,8 +368,8 @@ export const PetApiFp = {
};
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Pet> {
@ -385,8 +385,8 @@ export const PetApiFp = {
};
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -402,8 +402,8 @@ export const PetApiFp = {
};
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -421,8 +421,8 @@ export const PetApiFp = {
};
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -446,16 +446,16 @@ export const PetApiFp = {
*/
export class PetApi extends BaseAPI {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.addPet(params, options)(this.fetch, this.basePath);
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -463,40 +463,40 @@ export class PetApi extends BaseAPI {
return PetApiFp.deletePet(params, options)(this.fetch, this.basePath);
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByStatus(params, options)(this.fetch, this.basePath);
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByTags(params, options)(this.fetch, this.basePath);
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any) {
return PetApiFp.getPetById(params, options)(this.fetch, this.basePath);
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.updatePet(params, options)(this.fetch, this.basePath);
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -505,8 +505,8 @@ export class PetApi extends BaseAPI {
return PetApiFp.updatePetWithForm(params, options)(this.fetch, this.basePath);
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -522,16 +522,16 @@ export class PetApi extends BaseAPI {
export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.addPet(params, options)(fetch, basePath);
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -539,40 +539,40 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return PetApiFp.deletePet(params, options)(fetch, basePath);
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByStatus(params, options)(fetch, basePath);
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByTags(params, options)(fetch, basePath);
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any) {
return PetApiFp.getPetById(params, options)(fetch, basePath);
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.updatePet(params, options)(fetch, basePath);
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -581,8 +581,8 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return PetApiFp.updatePetWithForm(params, options)(fetch, basePath);
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -599,8 +599,8 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
*/
export const StoreApiFetchParamCreator = {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any): FetchArgs {
@ -623,8 +623,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any): FetchArgs {
const baseUrl = `/store/inventory`;
@ -641,8 +641,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any): FetchArgs {
@ -665,8 +665,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any): FetchArgs {
@ -694,8 +694,8 @@ export const StoreApiFetchParamCreator = {
*/
export const StoreApiFp = {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -711,8 +711,8 @@ export const StoreApiFp = {
};
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<{ [key: string]: number; }> {
const fetchArgs = StoreApiFetchParamCreator.getInventory(options);
@ -727,8 +727,8 @@ export const StoreApiFp = {
};
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Order> {
@ -744,8 +744,8 @@ export const StoreApiFp = {
};
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Order> {
@ -767,31 +767,31 @@ export const StoreApiFp = {
*/
export class StoreApi extends BaseAPI {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any) {
return StoreApiFp.deleteOrder(params, options)(this.fetch, this.basePath);
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any) {
return StoreApiFp.getInventory(options)(this.fetch, this.basePath);
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any) {
return StoreApiFp.getOrderById(params, options)(this.fetch, this.basePath);
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any) {
@ -805,31 +805,31 @@ export class StoreApi extends BaseAPI {
export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any) {
return StoreApiFp.deleteOrder(params, options)(fetch, basePath);
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any) {
return StoreApiFp.getInventory(options)(fetch, basePath);
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any) {
return StoreApiFp.getOrderById(params, options)(fetch, basePath);
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any) {
@ -844,8 +844,8 @@ export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) {
*/
export const UserApiFetchParamCreator = {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any): FetchArgs {
@ -867,8 +867,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any): FetchArgs {
@ -890,8 +890,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any): FetchArgs {
@ -913,8 +913,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any): FetchArgs {
@ -937,8 +937,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any): FetchArgs {
@ -961,8 +961,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -985,8 +985,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any): FetchArgs {
const baseUrl = `/user/logout`;
@ -1003,8 +1003,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1038,8 +1038,8 @@ export const UserApiFetchParamCreator = {
*/
export const UserApiFp = {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1055,8 +1055,8 @@ export const UserApiFp = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1072,8 +1072,8 @@ export const UserApiFp = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1089,8 +1089,8 @@ export const UserApiFp = {
};
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1106,8 +1106,8 @@ export const UserApiFp = {
};
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<User> {
@ -1123,8 +1123,8 @@ export const UserApiFp = {
};
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1141,8 +1141,8 @@ export const UserApiFp = {
};
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
const fetchArgs = UserApiFetchParamCreator.logoutUser(options);
@ -1157,8 +1157,8 @@ export const UserApiFp = {
};
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1181,48 +1181,48 @@ export const UserApiFp = {
*/
export class UserApi extends BaseAPI {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any) {
return UserApiFp.createUser(params, options)(this.fetch, this.basePath);
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithArrayInput(params, options)(this.fetch, this.basePath);
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithListInput(params, options)(this.fetch, this.basePath);
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any) {
return UserApiFp.deleteUser(params, options)(this.fetch, this.basePath);
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any) {
return UserApiFp.getUserByName(params, options)(this.fetch, this.basePath);
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1230,15 +1230,15 @@ export class UserApi extends BaseAPI {
return UserApiFp.loginUser(params, options)(this.fetch, this.basePath);
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any) {
return UserApiFp.logoutUser(options)(this.fetch, this.basePath);
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1253,48 +1253,48 @@ export class UserApi extends BaseAPI {
export const UserApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any) {
return UserApiFp.createUser(params, options)(fetch, basePath);
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithArrayInput(params, options)(fetch, basePath);
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithListInput(params, options)(fetch, basePath);
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any) {
return UserApiFp.deleteUser(params, options)(fetch, basePath);
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any) {
return UserApiFp.getUserByName(params, options)(fetch, basePath);
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1302,15 +1302,15 @@ export const UserApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return UserApiFp.loginUser(params, options)(fetch, basePath);
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any) {
return UserApiFp.logoutUser(options)(fetch, basePath);
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/

184
samples/client/petstore/typescript-fetch/builds/with-npm-version/api.ts
View File

@ -93,8 +93,8 @@ export interface User {
*/
export const PetApiFetchParamCreator = {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any): FetchArgs {
@ -116,8 +116,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -141,8 +141,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any): FetchArgs {
@ -163,8 +163,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any): FetchArgs {
@ -185,8 +185,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any): FetchArgs {
@ -209,8 +209,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any): FetchArgs {
@ -232,8 +232,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -263,8 +263,8 @@ export const PetApiFetchParamCreator = {
};
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -300,8 +300,8 @@ export const PetApiFetchParamCreator = {
*/
export const PetApiFp = {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -317,8 +317,8 @@ export const PetApiFp = {
};
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -335,8 +335,8 @@ export const PetApiFp = {
};
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<Pet>> {
@ -352,8 +352,8 @@ export const PetApiFp = {
};
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Array<Pet>> {
@ -369,8 +369,8 @@ export const PetApiFp = {
};
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Pet> {
@ -386,8 +386,8 @@ export const PetApiFp = {
};
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -403,8 +403,8 @@ export const PetApiFp = {
};
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -422,8 +422,8 @@ export const PetApiFp = {
};
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -447,16 +447,16 @@ export const PetApiFp = {
*/
export class PetApi extends BaseAPI {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.addPet(params, options)(this.fetch, this.basePath);
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -464,40 +464,40 @@ export class PetApi extends BaseAPI {
return PetApiFp.deletePet(params, options)(this.fetch, this.basePath);
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByStatus(params, options)(this.fetch, this.basePath);
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByTags(params, options)(this.fetch, this.basePath);
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any) {
return PetApiFp.getPetById(params, options)(this.fetch, this.basePath);
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.updatePet(params, options)(this.fetch, this.basePath);
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -506,8 +506,8 @@ export class PetApi extends BaseAPI {
return PetApiFp.updatePetWithForm(params, options)(this.fetch, this.basePath);
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -523,16 +523,16 @@ export class PetApi extends BaseAPI {
export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
addPet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.addPet(params, options)(fetch, basePath);
},
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -540,40 +540,40 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return PetApiFp.deletePet(params, options)(fetch, basePath);
},
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
findPetsByStatus(params: { "status"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByStatus(params, options)(fetch, basePath);
},
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
findPetsByTags(params: { "tags"?: Array<string>; }, options?: any) {
return PetApiFp.findPetsByTags(params, options)(fetch, basePath);
},
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
getPetById(params: { "petId": number; }, options?: any) {
return PetApiFp.getPetById(params, options)(fetch, basePath);
},
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
updatePet(params: { "body"?: Pet; }, options?: any) {
return PetApiFp.updatePet(params, options)(fetch, basePath);
},
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -582,8 +582,8 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return PetApiFp.updatePetWithForm(params, options)(fetch, basePath);
},
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -600,8 +600,8 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) {
*/
export const StoreApiFetchParamCreator = {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any): FetchArgs {
@ -624,8 +624,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any): FetchArgs {
const baseUrl = `/store/inventory`;
@ -642,8 +642,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any): FetchArgs {
@ -666,8 +666,8 @@ export const StoreApiFetchParamCreator = {
};
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any): FetchArgs {
@ -695,8 +695,8 @@ export const StoreApiFetchParamCreator = {
*/
export const StoreApiFp = {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -712,8 +712,8 @@ export const StoreApiFp = {
};
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<{ [key: string]: number; }> {
const fetchArgs = StoreApiFetchParamCreator.getInventory(options);
@ -728,8 +728,8 @@ export const StoreApiFp = {
};
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Order> {
@ -745,8 +745,8 @@ export const StoreApiFp = {
};
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Order> {
@ -768,31 +768,31 @@ export const StoreApiFp = {
*/
export class StoreApi extends BaseAPI {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any) {
return StoreApiFp.deleteOrder(params, options)(this.fetch, this.basePath);
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any) {
return StoreApiFp.getInventory(options)(this.fetch, this.basePath);
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any) {
return StoreApiFp.getOrderById(params, options)(this.fetch, this.basePath);
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any) {
@ -806,31 +806,31 @@ export class StoreApi extends BaseAPI {
export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
deleteOrder(params: { "orderId": string; }, options?: any) {
return StoreApiFp.deleteOrder(params, options)(fetch, basePath);
},
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
getInventory(options?: any) {
return StoreApiFp.getInventory(options)(fetch, basePath);
},
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
getOrderById(params: { "orderId": string; }, options?: any) {
return StoreApiFp.getOrderById(params, options)(fetch, basePath);
},
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
placeOrder(params: { "body"?: Order; }, options?: any) {
@ -845,8 +845,8 @@ export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) {
*/
export const UserApiFetchParamCreator = {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any): FetchArgs {
@ -868,8 +868,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any): FetchArgs {
@ -891,8 +891,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any): FetchArgs {
@ -914,8 +914,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any): FetchArgs {
@ -938,8 +938,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any): FetchArgs {
@ -962,8 +962,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -986,8 +986,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any): FetchArgs {
const baseUrl = `/user/logout`;
@ -1004,8 +1004,8 @@ export const UserApiFetchParamCreator = {
};
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1039,8 +1039,8 @@ export const UserApiFetchParamCreator = {
*/
export const UserApiFp = {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1056,8 +1056,8 @@ export const UserApiFp = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1073,8 +1073,8 @@ export const UserApiFp = {
};
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1090,8 +1090,8 @@ export const UserApiFp = {
};
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
@ -1107,8 +1107,8 @@ export const UserApiFp = {
};
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<User> {
@ -1124,8 +1124,8 @@ export const UserApiFp = {
};
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1142,8 +1142,8 @@ export const UserApiFp = {
};
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<any> {
const fetchArgs = UserApiFetchParamCreator.logoutUser(options);
@ -1158,8 +1158,8 @@ export const UserApiFp = {
};
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1182,48 +1182,48 @@ export const UserApiFp = {
*/
export class UserApi extends BaseAPI {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any) {
return UserApiFp.createUser(params, options)(this.fetch, this.basePath);
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithArrayInput(params, options)(this.fetch, this.basePath);
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithListInput(params, options)(this.fetch, this.basePath);
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any) {
return UserApiFp.deleteUser(params, options)(this.fetch, this.basePath);
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any) {
return UserApiFp.getUserByName(params, options)(this.fetch, this.basePath);
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1231,15 +1231,15 @@ export class UserApi extends BaseAPI {
return UserApiFp.loginUser(params, options)(this.fetch, this.basePath);
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any) {
return UserApiFp.logoutUser(options)(this.fetch, this.basePath);
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/
@ -1254,48 +1254,48 @@ export class UserApi extends BaseAPI {
export const UserApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return {
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
createUser(params: { "body"?: User; }, options?: any) {
return UserApiFp.createUser(params, options)(fetch, basePath);
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithArrayInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithArrayInput(params, options)(fetch, basePath);
},
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
createUsersWithListInput(params: { "body"?: Array<User>; }, options?: any) {
return UserApiFp.createUsersWithListInput(params, options)(fetch, basePath);
},
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
deleteUser(params: { "username": string; }, options?: any) {
return UserApiFp.deleteUser(params, options)(fetch, basePath);
},
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
getUserByName(params: { "username": string; }, options?: any) {
return UserApiFp.getUserByName(params, options)(fetch, basePath);
},
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1303,15 +1303,15 @@ export const UserApiFactory = function (fetch?: FetchAPI, basePath?: string) {
return UserApiFp.loginUser(params, options)(fetch, basePath);
},
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
logoutUser(options?: any) {
return UserApiFp.logoutUser(options)(fetch, basePath);
},
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/

46
samples/client/petstore/typescript-jquery/default/api.ts
View File

@ -158,8 +158,8 @@ export class PetApi {
}
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
public addPet (body?: Pet) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -203,8 +203,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -256,8 +256,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
public findPetsByStatus (status?: Array<string>) : JQueryPromise<{ response: JQueryXHR; body: Array<Pet>; }> {
@ -304,8 +304,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
public findPetsByTags (tags?: Array<string>) : JQueryPromise<{ response: JQueryXHR; body: Array<Pet>; }> {
@ -352,8 +352,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
public getPetById (petId: number) : JQueryPromise<{ response: JQueryXHR; body: Pet; }> {
@ -404,8 +404,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
public updatePet (body?: Pet) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -449,8 +449,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -511,8 +511,8 @@ export class PetApi {
return dfd.promise();
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -618,8 +618,8 @@ export class StoreApi {
}
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
public deleteOrder (orderId: string) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -666,8 +666,8 @@ export class StoreApi {
return dfd.promise();
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
public getInventory () : JQueryPromise<{ response: JQueryXHR; body: { [key: string]: number; }; }> {
let localVarPath = this.basePath + '/store/inventory';
@ -709,8 +709,8 @@ export class StoreApi {
return dfd.promise();
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
public getOrderById (orderId: string) : JQueryPromise<{ response: JQueryXHR; body: Order; }> {
@ -757,8 +757,8 @@ export class StoreApi {
return dfd.promise();
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
public placeOrder (body?: Order) : JQueryPromise<{ response: JQueryXHR; body: Order; }> {
@ -844,8 +844,8 @@ export class UserApi {
}
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
public createUser (body?: User) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -887,8 +887,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithArrayInput (body?: Array<User>) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -930,8 +930,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithListInput (body?: Array<User>) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -973,8 +973,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
public deleteUser (username: string) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -1021,8 +1021,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
public getUserByName (username: string) : JQueryPromise<{ response: JQueryXHR; body: User; }> {
@ -1069,8 +1069,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1120,8 +1120,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
public logoutUser () : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
let localVarPath = this.basePath + '/user/logout';
@ -1161,8 +1161,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/

46
samples/client/petstore/typescript-jquery/npm/api.ts
View File

@ -158,8 +158,8 @@ export class PetApi {
}
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
public addPet (body?: Pet) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -203,8 +203,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -256,8 +256,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
public findPetsByStatus (status?: Array<string>) : JQueryPromise<{ response: JQueryXHR; body: Array<Pet>; }> {
@ -304,8 +304,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
public findPetsByTags (tags?: Array<string>) : JQueryPromise<{ response: JQueryXHR; body: Array<Pet>; }> {
@ -352,8 +352,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
public getPetById (petId: number) : JQueryPromise<{ response: JQueryXHR; body: Pet; }> {
@ -404,8 +404,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
public updatePet (body?: Pet) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -449,8 +449,8 @@ export class PetApi {
return dfd.promise();
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -511,8 +511,8 @@ export class PetApi {
return dfd.promise();
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -618,8 +618,8 @@ export class StoreApi {
}
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
public deleteOrder (orderId: string) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -666,8 +666,8 @@ export class StoreApi {
return dfd.promise();
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
public getInventory () : JQueryPromise<{ response: JQueryXHR; body: { [key: string]: number; }; }> {
let localVarPath = this.basePath + '/store/inventory';
@ -709,8 +709,8 @@ export class StoreApi {
return dfd.promise();
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
public getOrderById (orderId: string) : JQueryPromise<{ response: JQueryXHR; body: Order; }> {
@ -757,8 +757,8 @@ export class StoreApi {
return dfd.promise();
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
public placeOrder (body?: Order) : JQueryPromise<{ response: JQueryXHR; body: Order; }> {
@ -844,8 +844,8 @@ export class UserApi {
}
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
public createUser (body?: User) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -887,8 +887,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithArrayInput (body?: Array<User>) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -930,8 +930,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithListInput (body?: Array<User>) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -973,8 +973,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
public deleteUser (username: string) : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
@ -1021,8 +1021,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
public getUserByName (username: string) : JQueryPromise<{ response: JQueryXHR; body: User; }> {
@ -1069,8 +1069,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1120,8 +1120,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
public logoutUser () : JQueryPromise<{ response: JQueryXHR; body?: any; }> {
let localVarPath = this.basePath + '/user/logout';
@ -1161,8 +1161,8 @@ export class UserApi {
return dfd.promise();
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/

46
samples/client/petstore/typescript-node/default/api.ts
View File

@ -187,8 +187,8 @@ export class PetApi {
this.authentications.petstore_auth.accessToken = token;
}
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
public addPet (body?: Pet) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -236,8 +236,8 @@ export class PetApi {
});
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -293,8 +293,8 @@ export class PetApi {
});
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
public findPetsByStatus (status?: Array<string>) : Promise<{ response: http.ClientResponse; body: Array<Pet>; }> {
@ -345,8 +345,8 @@ export class PetApi {
});
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
public findPetsByTags (tags?: Array<string>) : Promise<{ response: http.ClientResponse; body: Array<Pet>; }> {
@ -397,8 +397,8 @@ export class PetApi {
});
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
public getPetById (petId: number) : Promise<{ response: http.ClientResponse; body: Pet; }> {
@ -453,8 +453,8 @@ export class PetApi {
});
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
public updatePet (body?: Pet) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -502,8 +502,8 @@ export class PetApi {
});
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -566,8 +566,8 @@ export class PetApi {
});
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -683,8 +683,8 @@ export class StoreApi {
this.authentications.petstore_auth.accessToken = token;
}
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
public deleteOrder (orderId: string) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -735,8 +735,8 @@ export class StoreApi {
});
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
public getInventory () : Promise<{ response: http.ClientResponse; body: { [key: string]: number; }; }> {
const localVarPath = this.basePath + '/store/inventory';
@ -782,8 +782,8 @@ export class StoreApi {
});
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
public getOrderById (orderId: string) : Promise<{ response: http.ClientResponse; body: Order; }> {
@ -834,8 +834,8 @@ export class StoreApi {
});
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
public placeOrder (body?: Order) : Promise<{ response: http.ClientResponse; body: Order; }> {
@ -933,8 +933,8 @@ export class UserApi {
this.authentications.petstore_auth.accessToken = token;
}
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
public createUser (body?: User) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -980,8 +980,8 @@ export class UserApi {
});
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithArrayInput (body?: Array<User>) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -1027,8 +1027,8 @@ export class UserApi {
});
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithListInput (body?: Array<User>) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -1074,8 +1074,8 @@ export class UserApi {
});
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
public deleteUser (username: string) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -1126,8 +1126,8 @@ export class UserApi {
});
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
public getUserByName (username: string) : Promise<{ response: http.ClientResponse; body: User; }> {
@ -1178,8 +1178,8 @@ export class UserApi {
});
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1233,8 +1233,8 @@ export class UserApi {
});
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
public logoutUser () : Promise<{ response: http.ClientResponse; body?: any; }> {
const localVarPath = this.basePath + '/user/logout';
@ -1278,8 +1278,8 @@ export class UserApi {
});
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/

46
samples/client/petstore/typescript-node/npm/api.ts
View File

@ -187,8 +187,8 @@ export class PetApi {
this.authentications.petstore_auth.accessToken = token;
}
/**
* Add a new pet to the store
*
* @summary Add a new pet to the store
* @param body Pet object that needs to be added to the store
*/
public addPet (body?: Pet) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -236,8 +236,8 @@ export class PetApi {
});
}
/**
* Deletes a pet
*
* @summary Deletes a pet
* @param petId Pet id to delete
* @param apiKey
*/
@ -293,8 +293,8 @@ export class PetApi {
});
}
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @summary Finds Pets by status
* @param status Status values that need to be considered for filter
*/
public findPetsByStatus (status?: Array<string>) : Promise<{ response: http.ClientResponse; body: Array<Pet>; }> {
@ -345,8 +345,8 @@ export class PetApi {
});
}
/**
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @summary Finds Pets by tags
* @param tags Tags to filter by
*/
public findPetsByTags (tags?: Array<string>) : Promise<{ response: http.ClientResponse; body: Array<Pet>; }> {
@ -397,8 +397,8 @@ export class PetApi {
});
}
/**
* Find pet by ID
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
* @summary Find pet by ID
* @param petId ID of pet that needs to be fetched
*/
public getPetById (petId: number) : Promise<{ response: http.ClientResponse; body: Pet; }> {
@ -453,8 +453,8 @@ export class PetApi {
});
}
/**
* Update an existing pet
*
* @summary Update an existing pet
* @param body Pet object that needs to be added to the store
*/
public updatePet (body?: Pet) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -502,8 +502,8 @@ export class PetApi {
});
}
/**
* Updates a pet in the store with form data
*
* @summary Updates a pet in the store with form data
* @param petId ID of pet that needs to be updated
* @param name Updated name of the pet
* @param status Updated status of the pet
@ -566,8 +566,8 @@ export class PetApi {
});
}
/**
* uploads an image
*
* @summary uploads an image
* @param petId ID of pet to update
* @param additionalMetadata Additional data to pass to server
* @param file file to upload
@ -683,8 +683,8 @@ export class StoreApi {
this.authentications.petstore_auth.accessToken = token;
}
/**
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
* @summary Delete purchase order by ID
* @param orderId ID of the order that needs to be deleted
*/
public deleteOrder (orderId: string) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -735,8 +735,8 @@ export class StoreApi {
});
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @summary Returns pet inventories by status
*/
public getInventory () : Promise<{ response: http.ClientResponse; body: { [key: string]: number; }; }> {
const localVarPath = this.basePath + '/store/inventory';
@ -782,8 +782,8 @@ export class StoreApi {
});
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
* @summary Find purchase order by ID
* @param orderId ID of pet that needs to be fetched
*/
public getOrderById (orderId: string) : Promise<{ response: http.ClientResponse; body: Order; }> {
@ -834,8 +834,8 @@ export class StoreApi {
});
}
/**
* Place an order for a pet
*
* @summary Place an order for a pet
* @param body order placed for purchasing the pet
*/
public placeOrder (body?: Order) : Promise<{ response: http.ClientResponse; body: Order; }> {
@ -933,8 +933,8 @@ export class UserApi {
this.authentications.petstore_auth.accessToken = token;
}
/**
* Create user
* This can only be done by the logged in user.
* @summary Create user
* @param body Created user object
*/
public createUser (body?: User) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -980,8 +980,8 @@ export class UserApi {
});
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithArrayInput (body?: Array<User>) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -1027,8 +1027,8 @@ export class UserApi {
});
}
/**
* Creates list of users with given input array
*
* @summary Creates list of users with given input array
* @param body List of user object
*/
public createUsersWithListInput (body?: Array<User>) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -1074,8 +1074,8 @@ export class UserApi {
});
}
/**
* Delete user
* This can only be done by the logged in user.
* @summary Delete user
* @param username The name that needs to be deleted
*/
public deleteUser (username: string) : Promise<{ response: http.ClientResponse; body?: any; }> {
@ -1126,8 +1126,8 @@ export class UserApi {
});
}
/**
* Get user by user name
*
* @summary Get user by user name
* @param username The name that needs to be fetched. Use user1 for testing.
*/
public getUserByName (username: string) : Promise<{ response: http.ClientResponse; body: User; }> {
@ -1178,8 +1178,8 @@ export class UserApi {
});
}
/**
* Logs user into the system
*
* @summary Logs user into the system
* @param username The user name for login
* @param password The password for login in clear text
*/
@ -1233,8 +1233,8 @@ export class UserApi {
});
}
/**
* Logs out current logged in user session
*
* @summary Logs out current logged in user session
*/
public logoutUser () : Promise<{ response: http.ClientResponse; body?: any; }> {
const localVarPath = this.basePath + '/user/logout';
@ -1278,8 +1278,8 @@ export class UserApi {
});
}
/**
* Updated user
* This can only be done by the logged in user.
* @summary Updated user
* @param username name that need to be deleted
* @param body Updated user object
*/