diff --git a/modules/swagger-codegen/src/main/resources/TypeScript-Fetch/api.mustache b/modules/swagger-codegen/src/main/resources/TypeScript-Fetch/api.mustache index 1c48960c63da..deb227d02fde 100644 --- a/modules/swagger-codegen/src/main/resources/TypeScript-Fetch/api.mustache +++ b/modules/swagger-codegen/src/main/resources/TypeScript-Fetch/api.mustache @@ -76,10 +76,14 @@ export type {{{enumName}}} = {{#allowableValues}}{{#values}}"{{{.}}}"{{^-last}} */ export const {{classname}}FetchParamCreator = { {{#operation}} - /** {{#summary}} - * {{summary}}{{/summary}}{{#notes}} - * {{notes}}{{/notes}}{{#allParams}} - * @param {{paramName}} {{description}}{{/allParams}} + /** + * {{¬es}} + {{#summary}} + * @summary {{&summary}} + {{/summary}} + {{#allParams}} + * @param {{paramName}} {{description}} + {{/allParams}} */ {{nickname}}({{#hasParams}}params: { {{#allParams}} {{paramName}}{{^required}}?{{/required}}: {{{dataType}}};{{/allParams}} }, {{/hasParams}}{{#hasAuthMethods}}configuration: Configuration, {{/hasAuthMethods}}options: any = {}): FetchArgs { {{#allParams}} @@ -177,10 +181,14 @@ export const {{classname}}FetchParamCreator = { */ export const {{classname}}Fp = { {{#operation}} - /** {{#summary}} - * {{summary}}{{/summary}}{{#notes}} - * {{notes}}{{/notes}}{{#allParams}} - * @param {{paramName}} {{description}}{{/allParams}} + /** + * {{¬es}} + {{#summary}} + * @summary {{&summary}} + {{/summary}} + {{#allParams}} + * @param {{paramName}} {{description}} + {{/allParams}} */ {{nickname}}({{#hasParams}}params: { {{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}; {{/allParams}} }, {{/hasParams}}{{#hasAuthMethods}}configuration: Configuration, {{/hasAuthMethods}}options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}any{{/returnType}}> { const fetchArgs = {{classname}}FetchParamCreator.{{nickname}}({{#hasParams}}params, {{/hasParams}}{{#hasAuthMethods}}configuration, {{/hasAuthMethods}}options); @@ -203,10 +211,14 @@ export const {{classname}}Fp = { */ export class {{classname}} extends BaseAPI { {{#operation}} - /** {{#summary}} - * {{summary}}{{/summary}}{{#notes}} - * {{notes}}{{/notes}}{{#allParams}} - * @param {{paramName}} {{description}}{{/allParams}} + /** + * {{¬es}} + {{#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}}{{#hasAuthMethods}}this.configuration, {{/hasAuthMethods}}options)(this.fetch, this.basePath); @@ -221,10 +233,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}} + /** + * {{¬es}} + {{#summary}} + * @summary {{&summary}} + {{/summary}} + {{#allParams}} + * @param {{paramName}} {{description}} + {{/allParams}} */ {{nickname}}({{#hasParams}}params: { {{#allParams}} {{paramName}}{{^required}}?{{/required}}: {{{dataType}}};{{/allParams}} }, {{/hasParams}}{{#hasAuthMethods}}configuration: Configuration, {{/hasAuthMethods}}options: any = {}) { return {{classname}}Fp.{{nickname}}({{#hasParams}}params, {{/hasParams}}{{#hasAuthMethods}}configuration, {{/hasAuthMethods}}options)(fetch, basePath); diff --git a/modules/swagger-codegen/src/main/resources/typescript-angular/api.mustache b/modules/swagger-codegen/src/main/resources/typescript-angular/api.mustache index 8fc8ca79941f..856fb21fcabd 100644 --- a/modules/swagger-codegen/src/main/resources/typescript-angular/api.mustache +++ b/modules/swagger-codegen/src/main/resources/typescript-angular/api.mustache @@ -23,10 +23,12 @@ export class {{classname}} { {{#operation}} /** - * {{summary}} - * {{notes}} - {{#allParams}}* @param {{paramName}} {{description}} - {{/allParams}}*/ + * {{¬es}} + {{#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}}; diff --git a/modules/swagger-codegen/src/main/resources/typescript-angular2/api.service.mustache b/modules/swagger-codegen/src/main/resources/typescript-angular2/api.service.mustache index 712f800b6ebc..85f1fab8d9ee 100644 --- a/modules/swagger-codegen/src/main/resources/typescript-angular2/api.service.mustache +++ b/modules/swagger-codegen/src/main/resources/typescript-angular2/api.service.mustache @@ -79,7 +79,7 @@ export class {{classname}} { {{#operation}} /** - * {{notes}} + * {{¬es}} {{#summary}} * @summary {{&summary}} {{/summary}} diff --git a/modules/swagger-codegen/src/main/resources/typescript-jquery/api.mustache b/modules/swagger-codegen/src/main/resources/typescript-jquery/api.mustache index ffa5128b4f5d..b3697917496d 100644 --- a/modules/swagger-codegen/src/main/resources/typescript-jquery/api.mustache +++ b/modules/swagger-codegen/src/main/resources/typescript-jquery/api.mustache @@ -44,8 +44,10 @@ export class {{classname}} { {{#operation}} /** - * {{summary}} - * {{notes}} + * {{¬es}} + {{#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}} }> { diff --git a/modules/swagger-codegen/src/main/resources/typescript-node/api.mustache b/modules/swagger-codegen/src/main/resources/typescript-node/api.mustache index 765bc44a15e6..0aed7f531b83 100644 --- a/modules/swagger-codegen/src/main/resources/typescript-node/api.mustache +++ b/modules/swagger-codegen/src/main/resources/typescript-node/api.mustache @@ -360,8 +360,10 @@ export class {{classname}} { {{/authMethods}} {{#operation}} /** - * {{summary}} - * {{notes}} + * {{¬es}} + {{#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}} }> { diff --git a/samples/client/petstore/typescript-angular/api/PetApi.ts b/samples/client/petstore/typescript-angular/api/PetApi.ts index 887f87a1be9e..0d182b75d08b 100644 --- a/samples/client/petstore/typescript-angular/api/PetApi.ts +++ b/samples/client/petstore/typescript-angular/api/PetApi.ts @@ -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, extraHttpRequestParams?: any ) : ng.IHttpPromise> { 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, extraHttpRequestParams?: any ) : ng.IHttpPromise> { 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 < 10. ID > 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 { 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)); diff --git a/samples/client/petstore/typescript-angular/api/StoreApi.ts b/samples/client/petstore/typescript-angular/api/StoreApi.ts index efb81af53dfd..bb71dc9846e3 100644 --- a/samples/client/petstore/typescript-angular/api/StoreApi.ts +++ b/samples/client/petstore/typescript-angular/api/StoreApi.ts @@ -27,10 +27,10 @@ export class StoreApi { } /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 <= 5 or > 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 { 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 { const localVarPath = this.basePath + '/store/order'; diff --git a/samples/client/petstore/typescript-angular/api/UserApi.ts b/samples/client/petstore/typescript-angular/api/UserApi.ts index 15689b0c82df..63cbd7c4dcf8 100644 --- a/samples/client/petstore/typescript-angular/api/UserApi.ts +++ b/samples/client/petstore/typescript-angular/api/UserApi.ts @@ -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, 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, 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 { 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 { 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)); diff --git a/samples/client/petstore/typescript-fetch/builds/default/api.ts b/samples/client/petstore/typescript-fetch/builds/default/api.ts index db540732e5e4..4dda98a7489b 100644 --- a/samples/client/petstore/typescript-fetch/builds/default/api.ts +++ b/samples/client/petstore/typescript-fetch/builds/default/api.ts @@ -120,9 +120,9 @@ export interface User { * PetApi - fetch parameter creator */ 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -155,9 +155,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -188,9 +188,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -222,9 +222,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -256,10 +256,17 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, configuration: Configuration, options: any = {}): FetchArgs { // verify required parameter "petId" is set @@ -287,9 +294,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -322,9 +329,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 @@ -361,9 +368,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 @@ -406,9 +413,9 @@ export const PetApiFetchParamCreator = { * PetApi - functional programming interface */ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -423,9 +430,9 @@ export const PetApiFp = { }); }; }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -441,9 +448,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise> { @@ -458,9 +465,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise> { @@ -475,10 +482,17 @@ export const PetApiFp = { }); }; }, +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { const fetchArgs = PetApiFetchParamCreator.getPetById(params, configuration, options); @@ -492,9 +506,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -509,9 +523,9 @@ 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 @@ -528,9 +542,9 @@ 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 @@ -553,58 +567,65 @@ export const PetApiFp = { * PetApi - object-oriented interface */ 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, this.configuration, options)(this.fetch, this.basePath); } - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ deletePet(params: { petId: number; apiKey?: string; }, options: any = {}) { return PetApiFp.deletePet(params, this.configuration, 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; }, options: any = {}) { return PetApiFp.findPetsByStatus(params, this.configuration, 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; }, options: any = {}) { return PetApiFp.findPetsByTags(params, this.configuration, options)(this.fetch, this.basePath); } +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, options: any = {}) { return PetApiFp.getPetById(params, this.configuration, 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, this.configuration, 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 @@ -612,9 +633,9 @@ export class PetApi extends BaseAPI { updatePetWithForm(params: { petId: number; name?: string; status?: string; }, options: any = {}) { return PetApiFp.updatePetWithForm(params, this.configuration, 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 @@ -629,58 +650,65 @@ 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.addPet(params, configuration, options)(fetch, basePath); }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ deletePet(params: { petId: number; apiKey?: string; }, configuration: Configuration, options: any = {}) { return PetApiFp.deletePet(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.findPetsByStatus(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.findPetsByTags(params, configuration, options)(fetch, basePath); }, +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, configuration: Configuration, options: any = {}) { return PetApiFp.getPetById(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.updatePet(params, configuration, 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 @@ -688,9 +716,9 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) { updatePetWithForm(params: { petId: number; name?: string; status?: string; }, configuration: Configuration, options: any = {}) { return PetApiFp.updatePetWithForm(params, configuration, 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 @@ -706,9 +734,9 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) { * StoreApi - fetch parameter creator */ export const StoreApiFetchParamCreator = { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 { @@ -731,9 +759,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Returns pet inventories by status + /** * Returns a map of status codes to quantities + * @summary Returns pet inventories by status */ getInventory(configuration: Configuration, options: any = {}): FetchArgs { const baseUrl = `/store/inventory`; @@ -756,9 +784,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, options: any = {}): FetchArgs { @@ -781,9 +809,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -815,9 +843,9 @@ export const StoreApiFetchParamCreator = { * StoreApi - functional programming interface */ export const StoreApiFp = { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 { @@ -832,9 +860,9 @@ export const StoreApiFp = { }); }; }, - /** - * Returns pet inventories by status + /** * Returns a map of status codes to quantities + * @summary Returns pet inventories by status */ getInventory(configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise<{ [key: string]: number; }> { const fetchArgs = StoreApiFetchParamCreator.getInventory(configuration, options); @@ -848,9 +876,9 @@ export const StoreApiFp = { }); }; }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -865,9 +893,9 @@ 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 { @@ -888,32 +916,32 @@ export const StoreApiFp = { * StoreApi - object-oriented interface */ export class StoreApi extends BaseAPI { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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(this.configuration, options)(this.fetch, this.basePath); } - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, 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 = {}) { @@ -926,32 +954,32 @@ 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 < 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(configuration: Configuration, options: any = {}) { return StoreApiFp.getInventory(configuration, options)(fetch, basePath); }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, 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 = {}) { @@ -965,9 +993,9 @@ export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) { * UserApi - fetch parameter creator */ 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 { @@ -993,9 +1021,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, options: any = {}): FetchArgs { @@ -1021,9 +1049,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, options: any = {}): FetchArgs { @@ -1049,9 +1077,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -1074,9 +1102,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -1099,9 +1127,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 */ @@ -1132,9 +1160,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Logs out current logged in user session + /** * + * @summary Logs out current logged in user session */ logoutUser(options: any = {}): FetchArgs { const baseUrl = `/user/logout`; @@ -1151,9 +1179,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 */ @@ -1191,9 +1219,9 @@ export const UserApiFetchParamCreator = { * UserApi - functional programming interface */ 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 { @@ -1208,9 +1236,9 @@ 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; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -1225,9 +1253,9 @@ 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; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -1242,9 +1270,9 @@ 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 { @@ -1259,9 +1287,9 @@ 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 { @@ -1276,9 +1304,9 @@ 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 */ @@ -1294,9 +1322,9 @@ 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 { const fetchArgs = UserApiFetchParamCreator.logoutUser(options); @@ -1310,9 +1338,9 @@ 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 */ @@ -1334,65 +1362,65 @@ export const UserApiFp = { * UserApi - object-oriented interface */ 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; }, 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; }, 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 */ loginUser(params: { username: string; password: string; }, options: any = {}) { 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 */ @@ -1406,65 +1434,65 @@ 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; }, 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; }, 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 */ loginUser(params: { username: string; password: string; }, options: any = {}) { 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 */ diff --git a/samples/client/petstore/typescript-fetch/builds/es6-target/api.ts b/samples/client/petstore/typescript-fetch/builds/es6-target/api.ts index 2d289dbeb219..34fe19527f4d 100644 --- a/samples/client/petstore/typescript-fetch/builds/es6-target/api.ts +++ b/samples/client/petstore/typescript-fetch/builds/es6-target/api.ts @@ -119,9 +119,9 @@ export interface User { * PetApi - fetch parameter creator */ 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -154,9 +154,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -187,9 +187,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -221,9 +221,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -255,10 +255,17 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, configuration: Configuration, options: any = {}): FetchArgs { // verify required parameter "petId" is set @@ -286,9 +293,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -321,9 +328,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 @@ -360,9 +367,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 @@ -405,9 +412,9 @@ export const PetApiFetchParamCreator = { * PetApi - functional programming interface */ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -422,9 +429,9 @@ export const PetApiFp = { }); }; }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -440,9 +447,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise> { @@ -457,9 +464,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise> { @@ -474,10 +481,17 @@ export const PetApiFp = { }); }; }, +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { const fetchArgs = PetApiFetchParamCreator.getPetById(params, configuration, options); @@ -491,9 +505,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -508,9 +522,9 @@ 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 @@ -527,9 +541,9 @@ 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 @@ -552,58 +566,65 @@ export const PetApiFp = { * PetApi - object-oriented interface */ 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, this.configuration, options)(this.fetch, this.basePath); } - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ deletePet(params: { petId: number; apiKey?: string; }, options: any = {}) { return PetApiFp.deletePet(params, this.configuration, 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; }, options: any = {}) { return PetApiFp.findPetsByStatus(params, this.configuration, 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; }, options: any = {}) { return PetApiFp.findPetsByTags(params, this.configuration, options)(this.fetch, this.basePath); } +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, options: any = {}) { return PetApiFp.getPetById(params, this.configuration, 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, this.configuration, 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 @@ -611,9 +632,9 @@ export class PetApi extends BaseAPI { updatePetWithForm(params: { petId: number; name?: string; status?: string; }, options: any = {}) { return PetApiFp.updatePetWithForm(params, this.configuration, 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 @@ -628,58 +649,65 @@ 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.addPet(params, configuration, options)(fetch, basePath); }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ deletePet(params: { petId: number; apiKey?: string; }, configuration: Configuration, options: any = {}) { return PetApiFp.deletePet(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.findPetsByStatus(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.findPetsByTags(params, configuration, options)(fetch, basePath); }, +<<<<<<< HEAD /** * Find pet by ID * Returns a single pet * @param petId ID of pet to return +======= + /** + * 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 +>>>>>>> origin/master */ getPetById(params: { petId: number; }, configuration: Configuration, options: any = {}) { return PetApiFp.getPetById(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.updatePet(params, configuration, 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 @@ -687,9 +715,9 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) { updatePetWithForm(params: { petId: number; name?: string; status?: string; }, configuration: Configuration, options: any = {}) { return PetApiFp.updatePetWithForm(params, configuration, 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 @@ -705,9 +733,9 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) { * StoreApi - fetch parameter creator */ export const StoreApiFetchParamCreator = { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 { @@ -730,9 +758,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Returns pet inventories by status + /** * Returns a map of status codes to quantities + * @summary Returns pet inventories by status */ getInventory(configuration: Configuration, options: any = {}): FetchArgs { const baseUrl = `/store/inventory`; @@ -755,9 +783,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, options: any = {}): FetchArgs { @@ -780,9 +808,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -814,9 +842,9 @@ export const StoreApiFetchParamCreator = { * StoreApi - functional programming interface */ export const StoreApiFp = { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 { @@ -831,9 +859,9 @@ export const StoreApiFp = { }); }; }, - /** - * Returns pet inventories by status + /** * Returns a map of status codes to quantities + * @summary Returns pet inventories by status */ getInventory(configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise<{ [key: string]: number; }> { const fetchArgs = StoreApiFetchParamCreator.getInventory(configuration, options); @@ -847,9 +875,9 @@ export const StoreApiFp = { }); }; }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -864,9 +892,9 @@ 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 { @@ -887,32 +915,32 @@ export const StoreApiFp = { * StoreApi - object-oriented interface */ export class StoreApi extends BaseAPI { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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(this.configuration, options)(this.fetch, this.basePath); } - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, 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 = {}) { @@ -925,32 +953,32 @@ 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 < 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(configuration: Configuration, options: any = {}) { return StoreApiFp.getInventory(configuration, options)(fetch, basePath); }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, 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 = {}) { @@ -964,9 +992,9 @@ export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) { * UserApi - fetch parameter creator */ 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 { @@ -992,9 +1020,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, options: any = {}): FetchArgs { @@ -1020,9 +1048,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, options: any = {}): FetchArgs { @@ -1048,9 +1076,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -1073,9 +1101,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -1098,9 +1126,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 */ @@ -1131,9 +1159,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Logs out current logged in user session + /** * + * @summary Logs out current logged in user session */ logoutUser(options: any = {}): FetchArgs { const baseUrl = `/user/logout`; @@ -1150,9 +1178,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 */ @@ -1190,9 +1218,9 @@ export const UserApiFetchParamCreator = { * UserApi - functional programming interface */ 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 { @@ -1207,9 +1235,9 @@ 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; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -1224,9 +1252,9 @@ 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; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -1241,9 +1269,9 @@ 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 { @@ -1258,9 +1286,9 @@ 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 { @@ -1275,9 +1303,9 @@ 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 */ @@ -1293,9 +1321,9 @@ 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 { const fetchArgs = UserApiFetchParamCreator.logoutUser(options); @@ -1309,9 +1337,9 @@ 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 */ @@ -1333,65 +1361,65 @@ export const UserApiFp = { * UserApi - object-oriented interface */ 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; }, 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; }, 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 */ loginUser(params: { username: string; password: string; }, options: any = {}) { 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 */ @@ -1405,65 +1433,65 @@ 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; }, 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; }, 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 */ loginUser(params: { username: string; password: string; }, options: any = {}) { 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 */ diff --git a/samples/client/petstore/typescript-fetch/builds/with-npm-version/api.ts b/samples/client/petstore/typescript-fetch/builds/with-npm-version/api.ts index db540732e5e4..687baf11bba2 100644 --- a/samples/client/petstore/typescript-fetch/builds/with-npm-version/api.ts +++ b/samples/client/petstore/typescript-fetch/builds/with-npm-version/api.ts @@ -120,9 +120,9 @@ export interface User { * PetApi - fetch parameter creator */ 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -155,9 +155,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -188,9 +188,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -222,9 +222,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -256,10 +256,10 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Find pet by ID - * Returns a single pet - * @param petId ID of pet to return + /** + * 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; }, configuration: Configuration, options: any = {}): FetchArgs { // verify required parameter "petId" is set @@ -287,9 +287,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, configuration: Configuration, options: any = {}): FetchArgs { @@ -322,9 +322,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 @@ -361,9 +361,9 @@ export const PetApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 @@ -406,9 +406,9 @@ export const PetApiFetchParamCreator = { * PetApi - functional programming interface */ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -423,9 +423,9 @@ export const PetApiFp = { }); }; }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -441,9 +441,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise> { @@ -458,9 +458,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise> { @@ -475,10 +475,10 @@ export const PetApiFp = { }); }; }, - /** - * Find pet by ID - * Returns a single pet - * @param petId ID of pet to return + /** + * 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { const fetchArgs = PetApiFetchParamCreator.getPetById(params, configuration, options); @@ -492,9 +492,9 @@ 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; }, configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -509,9 +509,9 @@ 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 @@ -528,9 +528,9 @@ 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 @@ -553,58 +553,58 @@ export const PetApiFp = { * PetApi - object-oriented interface */ 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, this.configuration, options)(this.fetch, this.basePath); } - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ deletePet(params: { petId: number; apiKey?: string; }, options: any = {}) { return PetApiFp.deletePet(params, this.configuration, 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; }, options: any = {}) { return PetApiFp.findPetsByStatus(params, this.configuration, 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; }, options: any = {}) { return PetApiFp.findPetsByTags(params, this.configuration, options)(this.fetch, this.basePath); } - /** - * Find pet by ID - * Returns a single pet - * @param petId ID of pet to return + /** + * 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, this.configuration, 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, this.configuration, 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 @@ -612,9 +612,9 @@ export class PetApi extends BaseAPI { updatePetWithForm(params: { petId: number; name?: string; status?: string; }, options: any = {}) { return PetApiFp.updatePetWithForm(params, this.configuration, 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 @@ -629,58 +629,58 @@ 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.addPet(params, configuration, options)(fetch, basePath); }, - /** - * Deletes a pet + /** * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ deletePet(params: { petId: number; apiKey?: string; }, configuration: Configuration, options: any = {}) { return PetApiFp.deletePet(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.findPetsByStatus(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.findPetsByTags(params, configuration, options)(fetch, basePath); }, - /** - * Find pet by ID - * Returns a single pet - * @param petId ID of pet to return + /** + * 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.getPetById(params, configuration, 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; }, configuration: Configuration, options: any = {}) { return PetApiFp.updatePet(params, configuration, 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 @@ -688,9 +688,9 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) { updatePetWithForm(params: { petId: number; name?: string; status?: string; }, configuration: Configuration, options: any = {}) { return PetApiFp.updatePetWithForm(params, configuration, 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 @@ -706,9 +706,9 @@ export const PetApiFactory = function (fetch?: FetchAPI, basePath?: string) { * StoreApi - fetch parameter creator */ export const StoreApiFetchParamCreator = { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 { @@ -731,9 +731,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Returns pet inventories by status + /** * Returns a map of status codes to quantities + * @summary Returns pet inventories by status */ getInventory(configuration: Configuration, options: any = {}): FetchArgs { const baseUrl = `/store/inventory`; @@ -756,9 +756,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, options: any = {}): FetchArgs { @@ -781,9 +781,9 @@ export const StoreApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -815,9 +815,9 @@ export const StoreApiFetchParamCreator = { * StoreApi - functional programming interface */ export const StoreApiFp = { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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 { @@ -832,9 +832,9 @@ export const StoreApiFp = { }); }; }, - /** - * Returns pet inventories by status + /** * Returns a map of status codes to quantities + * @summary Returns pet inventories by status */ getInventory(configuration: Configuration, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise<{ [key: string]: number; }> { const fetchArgs = StoreApiFetchParamCreator.getInventory(configuration, options); @@ -848,9 +848,9 @@ export const StoreApiFp = { }); }; }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -865,9 +865,9 @@ 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 { @@ -888,32 +888,32 @@ export const StoreApiFp = { * StoreApi - object-oriented interface */ export class StoreApi extends BaseAPI { - /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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(this.configuration, options)(this.fetch, this.basePath); } - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, 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 = {}) { @@ -926,32 +926,32 @@ 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 < 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(configuration: Configuration, options: any = {}) { return StoreApiFp.getInventory(configuration, options)(fetch, basePath); }, - /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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: number; }, 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 = {}) { @@ -965,9 +965,9 @@ export const StoreApiFactory = function (fetch?: FetchAPI, basePath?: string) { * UserApi - fetch parameter creator */ 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 { @@ -993,9 +993,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, options: any = {}): FetchArgs { @@ -1021,9 +1021,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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; }, options: any = {}): FetchArgs { @@ -1049,9 +1049,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -1074,9 +1074,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 { @@ -1099,9 +1099,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 */ @@ -1132,9 +1132,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * Logs out current logged in user session + /** * + * @summary Logs out current logged in user session */ logoutUser(options: any = {}): FetchArgs { const baseUrl = `/user/logout`; @@ -1151,9 +1151,9 @@ export const UserApiFetchParamCreator = { options: fetchOptions, }; }, - /** - * 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 */ @@ -1191,9 +1191,9 @@ export const UserApiFetchParamCreator = { * UserApi - functional programming interface */ 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 { @@ -1208,9 +1208,9 @@ 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; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -1225,9 +1225,9 @@ 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; }, options: any = {}): (fetch: FetchAPI, basePath?: string) => Promise { @@ -1242,9 +1242,9 @@ 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 { @@ -1259,9 +1259,9 @@ 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 { @@ -1276,9 +1276,9 @@ 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 */ @@ -1294,9 +1294,9 @@ 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 { const fetchArgs = UserApiFetchParamCreator.logoutUser(options); @@ -1310,9 +1310,9 @@ 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 */ @@ -1334,65 +1334,65 @@ export const UserApiFp = { * UserApi - object-oriented interface */ 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; }, 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; }, 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 */ loginUser(params: { username: string; password: string; }, options: any = {}) { 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 */ @@ -1406,65 +1406,65 @@ 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; }, 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; }, 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 */ loginUser(params: { username: string; password: string; }, options: any = {}) { 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 */ diff --git a/samples/client/petstore/typescript-jquery/default/api.ts b/samples/client/petstore/typescript-jquery/default/api.ts index 635057c3432b..9bcd271b9ef4 100644 --- a/samples/client/petstore/typescript-jquery/default/api.ts +++ b/samples/client/petstore/typescript-jquery/default/api.ts @@ -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) : JQueryPromise<{ response: JQueryXHR; body: Array; }> { @@ -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) : JQueryPromise<{ response: JQueryXHR; body: Array; }> { @@ -352,8 +352,8 @@ export class PetApi { return dfd.promise(); } /** - * Find pet by ID - * Returns a pet when ID < 10. ID > 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 < 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 <= 5 or > 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) : 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) : 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 */ diff --git a/samples/client/petstore/typescript-jquery/npm/api.ts b/samples/client/petstore/typescript-jquery/npm/api.ts index 635057c3432b..9bcd271b9ef4 100644 --- a/samples/client/petstore/typescript-jquery/npm/api.ts +++ b/samples/client/petstore/typescript-jquery/npm/api.ts @@ -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) : JQueryPromise<{ response: JQueryXHR; body: Array; }> { @@ -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) : JQueryPromise<{ response: JQueryXHR; body: Array; }> { @@ -352,8 +352,8 @@ export class PetApi { return dfd.promise(); } /** - * Find pet by ID - * Returns a pet when ID < 10. ID > 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 < 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 <= 5 or > 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) : 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) : 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 */ diff --git a/samples/client/petstore/typescript-node/default/api.ts b/samples/client/petstore/typescript-node/default/api.ts index e3df99e6ef9a..b505139e8ab9 100644 --- a/samples/client/petstore/typescript-node/default/api.ts +++ b/samples/client/petstore/typescript-node/default/api.ts @@ -474,8 +474,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; }> { @@ -524,8 +524,8 @@ export class PetApi { }); } /** - * Deletes a pet * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -581,8 +581,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) : Promise<{ response: http.ClientResponse; body: Array; }> { @@ -635,8 +635,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) : Promise<{ response: http.ClientResponse; body: Array; }> { @@ -689,8 +689,8 @@ export class PetApi { }); } /** - * Find pet by ID - * Returns a pet when ID < 10. ID > 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; }> { @@ -747,8 +747,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; }> { @@ -797,8 +797,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 @@ -862,8 +862,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 @@ -980,8 +980,8 @@ export class StoreApi { this.authentications.petstore_auth.accessToken = token; } /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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; }> { @@ -1033,8 +1033,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'; @@ -1082,8 +1082,8 @@ export class StoreApi { }); } /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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; }> { @@ -1136,8 +1136,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; }> { @@ -1237,8 +1237,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; }> { @@ -1285,8 +1285,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) : Promise<{ response: http.ClientResponse; body?: any; }> { @@ -1333,8 +1333,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) : Promise<{ response: http.ClientResponse; body?: any; }> { @@ -1381,8 +1381,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; }> { @@ -1434,8 +1434,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; }> { @@ -1488,8 +1488,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 */ @@ -1545,8 +1545,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'; @@ -1591,8 +1591,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 */ diff --git a/samples/client/petstore/typescript-node/npm/api.ts b/samples/client/petstore/typescript-node/npm/api.ts index e3df99e6ef9a..b505139e8ab9 100644 --- a/samples/client/petstore/typescript-node/npm/api.ts +++ b/samples/client/petstore/typescript-node/npm/api.ts @@ -474,8 +474,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; }> { @@ -524,8 +524,8 @@ export class PetApi { }); } /** - * Deletes a pet * + * @summary Deletes a pet * @param petId Pet id to delete * @param apiKey */ @@ -581,8 +581,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) : Promise<{ response: http.ClientResponse; body: Array; }> { @@ -635,8 +635,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) : Promise<{ response: http.ClientResponse; body: Array; }> { @@ -689,8 +689,8 @@ export class PetApi { }); } /** - * Find pet by ID - * Returns a pet when ID < 10. ID > 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; }> { @@ -747,8 +747,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; }> { @@ -797,8 +797,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 @@ -862,8 +862,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 @@ -980,8 +980,8 @@ export class StoreApi { this.authentications.petstore_auth.accessToken = token; } /** - * Delete purchase order by ID - * For valid response try integer IDs with value < 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; }> { @@ -1033,8 +1033,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'; @@ -1082,8 +1082,8 @@ export class StoreApi { }); } /** - * Find purchase order by ID - * For valid response try integer IDs with value <= 5 or > 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; }> { @@ -1136,8 +1136,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; }> { @@ -1237,8 +1237,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; }> { @@ -1285,8 +1285,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) : Promise<{ response: http.ClientResponse; body?: any; }> { @@ -1333,8 +1333,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) : Promise<{ response: http.ClientResponse; body?: any; }> { @@ -1381,8 +1381,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; }> { @@ -1434,8 +1434,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; }> { @@ -1488,8 +1488,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 */ @@ -1545,8 +1545,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'; @@ -1591,8 +1591,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 */