diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java index 41574681763..e459db754c2 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java @@ -149,6 +149,7 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege @Override public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) { objs = super.postProcessOperationsWithModels(objs, allModels); + this.updateOperationParameterForEnum(objs); OperationMap vals = objs.getOperations(); List operations = vals.getOperation(); /* @@ -159,9 +160,24 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege .filter(op -> op.hasConsumes) .filter(op -> op.consumes.stream().anyMatch(opc -> opc.values().stream().anyMatch("multipart/form-data"::equals))) .forEach(op -> op.vendorExtensions.putIfAbsent("multipartFormData", true)); + return objs; } + private void updateOperationParameterForEnum(OperationsMap operations) { + // This method will add extra information as to whether or not we have enums and + // update their names with the operation.id prefixed. + // It will also set the uniqueId status if provided. + for (CodegenOperation op : operations.getOperations().getOperation()) { + for (CodegenParameter param : op.allParams) { + if (Boolean.TRUE.equals(param.isEnum)) { + param.datatypeWithEnum = param.datatypeWithEnum + .replace(param.enumName, op.operationIdCamelCase + param.enumName); + } + } + } + } + @Override public void postProcessParameter(CodegenParameter parameter) { super.postProcessParameter(parameter); diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache index 04812f66dde..1b9ad4ad451 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache @@ -40,13 +40,13 @@ export const {{classname}}AxiosParamCreator = function (configuration?: Configur * @summary {{&summary}} {{/summary}} {{#allParams}} - * @param {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} + * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} {{/allParams}} * @param {*} [options] Override http request option.{{#isDeprecated}} * @deprecated{{/isDeprecated}} * @throws {RequiredError} */ - {{nickname}}: async ({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options: AxiosRequestConfig = {}): Promise => { + {{nickname}}: async ({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options: AxiosRequestConfig = {}): Promise => { {{#allParams}} {{#required}} // verify required parameter '{{paramName}}' is not null or undefined @@ -224,13 +224,13 @@ export const {{classname}}Fp = function(configuration?: Configuration) { * @summary {{&summary}} {{/summary}} {{#allParams}} - * @param {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} + * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} {{/allParams}} * @param {*} [options] Override http request option.{{#isDeprecated}} * @deprecated{{/isDeprecated}} * @throws {RequiredError} */ - async {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>> { + async {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>> { const localVarAxiosArgs = await localVarAxiosParamCreator.{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -253,13 +253,13 @@ export const {{classname}}Factory = function (configuration?: Configuration, bas * @summary {{&summary}} {{/summary}} {{#allParams}} - * @param {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} + * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} {{/allParams}} * @param {*} [options] Override http request option.{{#isDeprecated}} * @deprecated{{/isDeprecated}} * @throws {RequiredError} */ - {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: any): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}> { + {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: any): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}> { return localVarFp.{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options).then((request) => request(axios, basePath)); }, {{/operation}} @@ -281,14 +281,14 @@ export interface {{classname}}Interface { * @summary {{&summary}} {{/summary}} {{#allParams}} - * @param {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} + * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} {{/allParams}} * @param {*} [options] Override http request option.{{#isDeprecated}} * @deprecated{{/isDeprecated}} * @throws {RequiredError} * @memberof {{classname}}Interface */ - {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: AxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>; + {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: AxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>; {{/operation}} } @@ -309,7 +309,7 @@ export interface {{classname}}{{operationIdCamelCase}}Request { * @type {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> * @memberof {{classname}}{{operationIdCamelCase}} */ - readonly {{paramName}}{{^required}}?{{/required}}: {{{dataType}}} + readonly {{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}} {{^-last}} {{/-last}} @@ -345,7 +345,7 @@ export class {{classname}} extends BaseAPI { {{/useSingleRequestParameter}} {{^useSingleRequestParameter}} {{#allParams}} - * @param {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} + * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}} {{/allParams}} {{/useSingleRequestParameter}} * @param {*} [options] Override http request option.{{#isDeprecated}} @@ -359,7 +359,7 @@ export class {{classname}} extends BaseAPI { } {{/useSingleRequestParameter}} {{^useSingleRequestParameter}} - public {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}options?: AxiosRequestConfig) { + public {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: AxiosRequestConfig) { return {{classname}}Fp(this.configuration).{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options).then((request) => request(this.axios, this.basePath)); } {{/useSingleRequestParameter}} @@ -369,3 +369,38 @@ export class {{classname}} extends BaseAPI { {{/operation}} } {{/operations}} + +{{#operations}} +{{#operation}} +{{#allParams}} +{{#isEnum}} +{{#stringEnums}} +/** + * @export + * @enum {string} + */ +export enum {{operationIdCamelCase}}{{enumName}} { +{{#allowableValues}} + {{#enumVars}} + {{{name}}} = {{{value}}}{{^-last}},{{/-last}} + {{/enumVars}} +{{/allowableValues}} +} +{{/stringEnums}} +{{^stringEnums}} +/** + * @export + */ +export const {{operationIdCamelCase}}{{enumName}} = { +{{#allowableValues}} + {{#enumVars}} + {{{name}}}: {{{value}}}{{^-last}},{{/-last}} + {{/enumVars}} +{{/allowableValues}} +} as const; +export type {{operationIdCamelCase}}{{enumName}} = typeof {{operationIdCamelCase}}{{enumName}}[keyof typeof {{operationIdCamelCase}}{{enumName}}]; +{{/stringEnums}} +{{/isEnum}} +{{/allParams}} +{{/operation}} +{{/operations}} diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts b/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts index 2d67e559471..5911007ed2f 100644 --- a/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts @@ -449,3 +449,4 @@ export class DefaultApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/default/api.ts b/samples/client/petstore/typescript-axios/builds/default/api.ts index 893802cbed3..e6faa73c1a7 100644 --- a/samples/client/petstore/typescript-axios/builds/default/api.ts +++ b/samples/client/petstore/typescript-axios/builds/default/api.ts @@ -336,11 +336,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -633,11 +633,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -735,11 +735,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -835,12 +835,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -910,6 +910,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1215,6 +1225,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -1810,3 +1821,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/api.ts b/samples/client/petstore/typescript-axios/builds/es6-target/api.ts index 893802cbed3..e6faa73c1a7 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/api.ts +++ b/samples/client/petstore/typescript-axios/builds/es6-target/api.ts @@ -336,11 +336,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -633,11 +633,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -735,11 +735,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -835,12 +835,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -910,6 +910,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1215,6 +1225,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -1810,3 +1821,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts b/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts index 0d480e40bc0..fa54a47c8bb 100644 --- a/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts @@ -1838,6 +1838,7 @@ export class AnotherFakeApi extends BaseAPI { } + /** * DefaultApi - axios parameter creator * @export @@ -1932,6 +1933,7 @@ export class DefaultApi extends BaseAPI { } + /** * FakeApi - axios parameter creator * @export @@ -2362,18 +2364,18 @@ export const FakeApiAxiosParamCreator = function (configuration?: Configuration) /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - testEnumParameters: async (enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options: AxiosRequestConfig = {}): Promise => { + testEnumParameters: async (enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/fake`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -2781,18 +2783,18 @@ export const FakeApiFp = function(configuration?: Configuration) { /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async testEnumParameters(enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -2968,18 +2970,18 @@ export const FakeApiFactory = function (configuration?: Configuration, basePath? /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - testEnumParameters(enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options?: any): AxiosPromise { + testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: any): AxiosPromise { return localVarFp.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options).then((request) => request(axios, basePath)); }, /** @@ -3170,19 +3172,19 @@ export class FakeApi extends BaseAPI { /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FakeApi */ - public testEnumParameters(enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options?: AxiosRequestConfig) { + public testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: AxiosRequestConfig) { return FakeApiFp(this.configuration).testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options).then((request) => request(this.axios, this.basePath)); } @@ -3244,6 +3246,74 @@ export class FakeApi extends BaseAPI { } } +/** + * @export + */ +export const TestEnumParametersEnumHeaderStringArrayEnum = { + GreaterThan: '>', + Dollar: '$' +} as const; +export type TestEnumParametersEnumHeaderStringArrayEnum = typeof TestEnumParametersEnumHeaderStringArrayEnum[keyof typeof TestEnumParametersEnumHeaderStringArrayEnum]; +/** + * @export + */ +export const TestEnumParametersEnumHeaderStringEnum = { + Abc: '_abc', + Efg: '-efg', + Xyz: '(xyz)' +} as const; +export type TestEnumParametersEnumHeaderStringEnum = typeof TestEnumParametersEnumHeaderStringEnum[keyof typeof TestEnumParametersEnumHeaderStringEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryStringArrayEnum = { + GreaterThan: '>', + Dollar: '$' +} as const; +export type TestEnumParametersEnumQueryStringArrayEnum = typeof TestEnumParametersEnumQueryStringArrayEnum[keyof typeof TestEnumParametersEnumQueryStringArrayEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryStringEnum = { + Abc: '_abc', + Efg: '-efg', + Xyz: '(xyz)' +} as const; +export type TestEnumParametersEnumQueryStringEnum = typeof TestEnumParametersEnumQueryStringEnum[keyof typeof TestEnumParametersEnumQueryStringEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryIntegerEnum = { + NUMBER_1: 1, + NUMBER_MINUS_2: -2 +} as const; +export type TestEnumParametersEnumQueryIntegerEnum = typeof TestEnumParametersEnumQueryIntegerEnum[keyof typeof TestEnumParametersEnumQueryIntegerEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryDoubleEnum = { + NUMBER_1_DOT_1: 1.1, + NUMBER_MINUS_1_DOT_2: -1.2 +} as const; +export type TestEnumParametersEnumQueryDoubleEnum = typeof TestEnumParametersEnumQueryDoubleEnum[keyof typeof TestEnumParametersEnumQueryDoubleEnum]; +/** + * @export + */ +export const TestEnumParametersEnumFormStringArrayEnum = { + GreaterThan: '>', + Dollar: '$' +} as const; +export type TestEnumParametersEnumFormStringArrayEnum = typeof TestEnumParametersEnumFormStringArrayEnum[keyof typeof TestEnumParametersEnumFormStringArrayEnum]; +/** + * @export + */ +export const TestEnumParametersEnumFormStringEnum = { + Abc: '_abc', + Efg: '-efg', + Xyz: '(xyz)' +} as const; +export type TestEnumParametersEnumFormStringEnum = typeof TestEnumParametersEnumFormStringEnum[keyof typeof TestEnumParametersEnumFormStringEnum]; + /** * FakeClassnameTags123Api - axios parameter creator @@ -3355,6 +3425,7 @@ export class FakeClassnameTags123Api extends BaseAPI { } + /** * PetApi - axios parameter creator * @export @@ -3449,11 +3520,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -3806,11 +3877,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -3921,11 +3992,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -4033,12 +4104,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -4122,6 +4193,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -4427,6 +4508,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -5022,3 +5104,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts b/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts index 8c7d0abac4a..6eeef75c6ab 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts @@ -347,11 +347,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -646,11 +646,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -750,11 +750,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -852,12 +852,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -927,6 +927,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1232,6 +1242,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -1827,3 +1838,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts index 393e19a74eb..24f390bef9d 100644 --- a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts @@ -1466,6 +1466,7 @@ export class AnotherFakeApi extends BaseAPI { } + /** * DefaultApi - axios parameter creator * @export @@ -1560,6 +1561,7 @@ export class DefaultApi extends BaseAPI { } + /** * FakeApi - axios parameter creator * @export @@ -1960,18 +1962,18 @@ export const FakeApiAxiosParamCreator = function (configuration?: Configuration) /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - testEnumParameters: async (enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options: AxiosRequestConfig = {}): Promise => { + testEnumParameters: async (enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/fake`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -2413,18 +2415,18 @@ export const FakeApiFp = function(configuration?: Configuration) { /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async testEnumParameters(enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -2602,18 +2604,18 @@ export const FakeApiFactory = function (configuration?: Configuration, basePath? /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - testEnumParameters(enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options?: any): AxiosPromise { + testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: any): AxiosPromise { return localVarFp.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options).then((request) => request(axios, basePath)); }, /** @@ -2803,19 +2805,19 @@ export class FakeApi extends BaseAPI { /** * To test enum parameters * @summary To test enum parameters - * @param {Array<'>' | '$'>} [enumHeaderStringArray] Header parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumHeaderString] Header parameter enum test (string) - * @param {Array<'>' | '$'>} [enumQueryStringArray] Query parameter enum test (string array) - * @param {'_abc' | '-efg' | '(xyz)'} [enumQueryString] Query parameter enum test (string) - * @param {1 | -2} [enumQueryInteger] Query parameter enum test (double) - * @param {1.1 | -1.2} [enumQueryDouble] Query parameter enum test (double) - * @param {Array} [enumFormStringArray] Form parameter enum test (string array) - * @param {string} [enumFormString] Form parameter enum test (string) + * @param {Array} [enumHeaderStringArray] Header parameter enum test (string array) + * @param {TestEnumParametersEnumHeaderStringEnum} [enumHeaderString] Header parameter enum test (string) + * @param {Array} [enumQueryStringArray] Query parameter enum test (string array) + * @param {TestEnumParametersEnumQueryStringEnum} [enumQueryString] Query parameter enum test (string) + * @param {TestEnumParametersEnumQueryIntegerEnum} [enumQueryInteger] Query parameter enum test (double) + * @param {TestEnumParametersEnumQueryDoubleEnum} [enumQueryDouble] Query parameter enum test (double) + * @param {Array} [enumFormStringArray] Form parameter enum test (string array) + * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FakeApi */ - public testEnumParameters(enumHeaderStringArray?: Array<'>' | '$'>, enumHeaderString?: '_abc' | '-efg' | '(xyz)', enumQueryStringArray?: Array<'>' | '$'>, enumQueryString?: '_abc' | '-efg' | '(xyz)', enumQueryInteger?: 1 | -2, enumQueryDouble?: 1.1 | -1.2, enumFormStringArray?: Array, enumFormString?: string, options?: AxiosRequestConfig) { + public testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: AxiosRequestConfig) { return FakeApiFp(this.configuration).testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options).then((request) => request(this.axios, this.basePath)); } @@ -2889,6 +2891,74 @@ export class FakeApi extends BaseAPI { } } +/** + * @export + */ +export const TestEnumParametersEnumHeaderStringArrayEnum = { + GreaterThan: '>', + Dollar: '$' +} as const; +export type TestEnumParametersEnumHeaderStringArrayEnum = typeof TestEnumParametersEnumHeaderStringArrayEnum[keyof typeof TestEnumParametersEnumHeaderStringArrayEnum]; +/** + * @export + */ +export const TestEnumParametersEnumHeaderStringEnum = { + Abc: '_abc', + Efg: '-efg', + Xyz: '(xyz)' +} as const; +export type TestEnumParametersEnumHeaderStringEnum = typeof TestEnumParametersEnumHeaderStringEnum[keyof typeof TestEnumParametersEnumHeaderStringEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryStringArrayEnum = { + GreaterThan: '>', + Dollar: '$' +} as const; +export type TestEnumParametersEnumQueryStringArrayEnum = typeof TestEnumParametersEnumQueryStringArrayEnum[keyof typeof TestEnumParametersEnumQueryStringArrayEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryStringEnum = { + Abc: '_abc', + Efg: '-efg', + Xyz: '(xyz)' +} as const; +export type TestEnumParametersEnumQueryStringEnum = typeof TestEnumParametersEnumQueryStringEnum[keyof typeof TestEnumParametersEnumQueryStringEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryIntegerEnum = { + NUMBER_1: 1, + NUMBER_MINUS_2: -2 +} as const; +export type TestEnumParametersEnumQueryIntegerEnum = typeof TestEnumParametersEnumQueryIntegerEnum[keyof typeof TestEnumParametersEnumQueryIntegerEnum]; +/** + * @export + */ +export const TestEnumParametersEnumQueryDoubleEnum = { + NUMBER_1_DOT_1: 1.1, + NUMBER_MINUS_1_DOT_2: -1.2 +} as const; +export type TestEnumParametersEnumQueryDoubleEnum = typeof TestEnumParametersEnumQueryDoubleEnum[keyof typeof TestEnumParametersEnumQueryDoubleEnum]; +/** + * @export + */ +export const TestEnumParametersEnumFormStringArrayEnum = { + GreaterThan: '>', + Dollar: '$' +} as const; +export type TestEnumParametersEnumFormStringArrayEnum = typeof TestEnumParametersEnumFormStringArrayEnum[keyof typeof TestEnumParametersEnumFormStringArrayEnum]; +/** + * @export + */ +export const TestEnumParametersEnumFormStringEnum = { + Abc: '_abc', + Efg: '-efg', + Xyz: '(xyz)' +} as const; +export type TestEnumParametersEnumFormStringEnum = typeof TestEnumParametersEnumFormStringEnum[keyof typeof TestEnumParametersEnumFormStringEnum]; + /** * FakeClassnameTags123Api - axios parameter creator @@ -3000,6 +3070,7 @@ export class FakeClassnameTags123Api extends BaseAPI { } + /** * PetApi - axios parameter creator * @export @@ -3094,11 +3165,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -3451,11 +3522,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -3566,11 +3637,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -3678,12 +3749,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -3767,6 +3838,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -4072,6 +4153,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -4667,3 +4749,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts index d808b5aa937..367b5114e26 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts @@ -336,11 +336,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -633,11 +633,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -735,11 +735,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -830,12 +830,12 @@ export interface PetApiInterface { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApiInterface */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): AxiosPromise>; + findPetsByStatus(status: Array, options?: AxiosRequestConfig): AxiosPromise>; /** * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. @@ -929,12 +929,12 @@ export class PetApi extends BaseAPI implements PetApiInterface { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -1004,6 +1004,16 @@ export class PetApi extends BaseAPI implements PetApiInterface { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1356,6 +1366,7 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { } + /** * UserApi - axios parameter creator * @export @@ -2040,3 +2051,4 @@ export class UserApi extends BaseAPI implements UserApiInterface { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts b/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts index 0cfec1ad4b3..ddc20affd19 100644 --- a/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts @@ -340,11 +340,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -637,11 +637,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -739,11 +739,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -839,12 +839,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -914,6 +914,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1217,6 +1227,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -1812,3 +1823,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts index d84bdc20973..a5baf3f11d9 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts @@ -116,11 +116,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -413,11 +413,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -515,11 +515,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -615,12 +615,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -689,3 +689,13 @@ export class PetApi extends BaseAPI { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } + +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts index bf058d959f5..766b65554b7 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts @@ -324,3 +324,4 @@ export class StoreApi extends BaseAPI { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); } } + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts index 44258306cc5..541ceeb514b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts @@ -615,3 +615,4 @@ export class UserApi extends BaseAPI { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); } } + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts index 893802cbed3..e6faa73c1a7 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts @@ -336,11 +336,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -633,11 +633,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -735,11 +735,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -835,12 +835,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -910,6 +910,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1215,6 +1225,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -1810,3 +1821,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts index 5a06a70cb99..456715e5444 100644 --- a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts @@ -336,11 +336,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -633,11 +633,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -735,11 +735,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -846,7 +846,7 @@ export interface PetApiFindPetsByStatusRequest { * @type {Array<'available' | 'pending' | 'sold'>} * @memberof PetApiFindPetsByStatus */ - readonly status: Array<'available' | 'pending' | 'sold'> + readonly status: Array } /** @@ -1052,6 +1052,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + */ +export const FindPetsByStatusStatusEnum = { + Available: 'available', + Pending: 'pending', + Sold: 'sold' +} as const; +export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum]; + /** * StoreApi - axios parameter creator @@ -1397,6 +1407,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -2102,3 +2113,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts b/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts index fd8ae456d7a..7ccec3de05e 100644 --- a/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts @@ -340,11 +340,11 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, options: AxiosRequestConfig = {}): Promise => { + findPetsByStatus: async (status: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'status' is not null or undefined assertParamExists('findPetsByStatus', 'status', status) const localVarPath = `/pet/findByStatus`; @@ -637,11 +637,11 @@ export const PetApiFp = function(configuration?: Configuration) { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async findPetsByStatus(status: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.findPetsByStatus(status, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -739,11 +739,11 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: any): AxiosPromise> { + findPetsByStatus(status: Array, options?: any): AxiosPromise> { return localVarFp.findPetsByStatus(status, options).then((request) => request(axios, basePath)); }, /** @@ -839,12 +839,12 @@ export class PetApi extends BaseAPI { /** * Multiple status values can be provided with comma separated strings * @summary Finds Pets by status - * @param {Array<'available' | 'pending' | 'sold'>} status Status values that need to be considered for filter + * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PetApi */ - public findPetsByStatus(status: Array<'available' | 'pending' | 'sold'>, options?: AxiosRequestConfig) { + public findPetsByStatus(status: Array, options?: AxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); } @@ -914,6 +914,16 @@ export class PetApi extends BaseAPI { } } +/** + * @export + * @enum {string} + */ +export enum FindPetsByStatusStatusEnum { + Available = 'available', + Pending = 'pending', + Sold = 'sold' +} + /** * StoreApi - axios parameter creator @@ -1219,6 +1229,7 @@ export class StoreApi extends BaseAPI { } + /** * UserApi - axios parameter creator * @export @@ -1814,3 +1825,4 @@ export class UserApi extends BaseAPI { } + diff --git a/samples/client/petstore/typescript-rxjs/builds/with-npm-version/pom.xml b/samples/client/petstore/typescript-rxjs/builds/with-npm-version/pom.xml index 6414f36047f..5360e135824 100644 --- a/samples/client/petstore/typescript-rxjs/builds/with-npm-version/pom.xml +++ b/samples/client/petstore/typescript-rxjs/builds/with-npm-version/pom.xml @@ -26,6 +26,21 @@ exec-maven-plugin 1.2.1 + + node-install + pre-integration-test + + exec + + + npm + + install + -D + @types/node + + + npm-install pre-integration-test