Skip to content

fix(typescript-fetch): generate validationAttributes when withoutRuntimeChecks=true #23107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
macjohnny merged 2 commits into from
Mar 4, 2026
Merged

fix(typescript-fetch): generate validationAttributes when withoutRuntimeChecks=true #23107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c4743c
fix(typescript-fetch): generate validationAttributes when withoutRunt…
gurkodil Mar 3, 2026
0bf54dd
update samples
gurkodil Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 0 additions & 65 deletions modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,68 +194,3 @@ export function {{classname}}ToJSONTyped(value?: {{#hasReadOnly}}Omit<{{classnam
return value;
{{/hasVars}}
}
{{#validationAttributes}}

export const {{classname}}PropertyValidationAttributesMap: {
Copy link
Copy Markdown
Member

@macjohnny macjohnny Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this change backwards compatible? maybe people imported this map from this file?

Copy link
Copy Markdown
Contributor Author

@gurkodil gurkodil Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be backwards compatible, this template includes the modelGenericInterfaces.mustache (which renders this map) as a partial, so this map will still be rendered in this file.

[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
{{#vars}}
{{#hasValidation}}
{{name}}: {
{{#maxLength}}
maxLength: {{maxLength}},
{{/maxLength}}
{{#minLength}}
minLength: {{minLength}},
{{/minLength}}
{{#pattern}}
pattern: '{{pattern}}',
{{/pattern}}
{{#maximum}}
maximum: {{maximum}},
exclusiveMaximum: {{exclusiveMaximum}},
{{/maximum}}
{{#minimum}}
minimum: {{minimum}},
exclusiveMinimum: {{exclusiveMinimum}},
{{/minimum}}
{{#multipleOf}}
multipleOf: {{multipleOf}},
{{/multipleOf}}
{{#maxItems}}
maxItems: {{maxItems}},
{{/maxItems}}
{{#minItems}}
minItems: {{minItems}},
{{/minItems}}
{{#isArray}}
uniqueItems: {{uniqueItems}},
{{/isArray}}
},
{{/hasValidation}}
{{/vars}}
}
{{#isAdditionalPropertiesTrue}}

export const {{classname}}AdditionalPropertiesValidationAttributes: { maxProperties?: number, minProperties?: number } = {
{{#maxProperties}}
maxProperties: {{maxProperties}},
{{/maxProperties}}
{{#minProperties}}
minProperties: {{minProperties}},
{{/minProperties}}
}
{{/isAdditionalPropertiesTrue}}
{{/validationAttributes}}
2 changes: 1 addition & 1 deletion ...les/openapi-generator/src/main/resources/typescript-fetch/modelGenericInterfaces.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ export const {{classname}}{{enumName}} = {
} as const;
export type {{classname}}{{enumName}} = typeof {{classname}}{{enumName}}[keyof typeof {{classname}}{{enumName}}];
{{/stringEnums}}
{{/isEnum}}{{/vars}}{{/hasEnums}}
{{/isEnum}}{{/vars}}{{/hasEnums}}{{>validationAttributes}}
65 changes: 65 additions & 0 deletions modules/openapi-generator/src/main/resources/typescript-fetch/validationAttributes.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{{#validationAttributes}}
Copy link
Copy Markdown
Member

@macjohnny macjohnny Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this change require any import changes in any of the mustache files?

Copy link
Copy Markdown
Contributor Author

@gurkodil gurkodil Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no it should be ok, since the map is included in the modelGeneric.mustache, anything that previously imported from this file still works as before. And for this partial itself it only uses primitive types so no additional imports are needed in the generated output when this is used


export const {{classname}}PropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
{{#vars}}
{{#hasValidation}}
{{name}}: {
{{#maxLength}}
maxLength: {{maxLength}},
{{/maxLength}}
{{#minLength}}
minLength: {{minLength}},
{{/minLength}}
{{#pattern}}
pattern: '{{pattern}}',
{{/pattern}}
{{#maximum}}
maximum: {{maximum}},
exclusiveMaximum: {{exclusiveMaximum}},
{{/maximum}}
{{#minimum}}
minimum: {{minimum}},
exclusiveMinimum: {{exclusiveMinimum}},
{{/minimum}}
{{#multipleOf}}
multipleOf: {{multipleOf}},
{{/multipleOf}}
{{#maxItems}}
maxItems: {{maxItems}},
{{/maxItems}}
{{#minItems}}
minItems: {{minItems}},
{{/minItems}}
{{#isArray}}
uniqueItems: {{uniqueItems}},
{{/isArray}}
},
{{/hasValidation}}
{{/vars}}
}
{{#isAdditionalPropertiesTrue}}

export const {{classname}}AdditionalPropertiesValidationAttributes: { maxProperties?: number, minProperties?: number } = {
{{#maxProperties}}
maxProperties: {{maxProperties}},
{{/maxProperties}}
{{#minProperties}}
minProperties: {{minProperties}},
{{/minProperties}}
}
{{/isAdditionalPropertiesTrue}}
{{/validationAttributes}}
14 changes: 14 additions & 0 deletions ...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,20 @@ public void testOneOfModelsImportNonPrimitiveTypes() throws IOException {
TestUtils.assertFileContains(testResponse, "import type { OptionThree } from './OptionThree'");
}

@Test(description = "Verify validationAttributes works with withoutRuntimeChecks=true")
public void testValidationAttributesWithWithoutRuntimeChecks() throws IOException {
Map<String, Object> properties = new HashMap<>();
properties.put(TypeScriptFetchClientCodegen.VALIDATION_ATTRIBUTES, true);
properties.put(TypeScriptFetchClientCodegen.WITHOUT_RUNTIME_CHECKS, true);

File output = generate(properties, "src/test/resources/3_0/typescript-fetch/validation-attributes.yaml");

Path modelsIndex = Paths.get(output + "/models/index.ts");
TestUtils.assertFileExists(modelsIndex);
TestUtils.assertFileContains(modelsIndex, "PetPropertyValidationAttributesMap");
TestUtils.assertFileContains(modelsIndex, "[property: string]:");
}

private static File generate(
Map<String, Object> properties
) throws IOException {
Expand Down
40 changes: 20 additions & 20 deletions samples/client/petstore/typescript-fetch/builds/validation-attributes/models/Category.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,26 @@ export interface Category {
*/
name?: string;
}
export const CategoryPropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
name: {
pattern: '/^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$/',
},
}


/**
* Check if a given object implements the Category interface.
Expand Down Expand Up @@ -71,23 +91,3 @@ export function CategoryToJSONTyped(value?: Category | null, ignoreDiscriminator
};
}

export const CategoryPropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
name: {
pattern: '/^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$/',
},
}

34 changes: 17 additions & 17 deletions .../client/petstore/typescript-fetch/builds/validation-attributes/models/ModelApiResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,23 @@ export interface ModelApiResponse {
*/
message?: string;
}
export const ModelApiResponsePropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
Comment thread
gurkodil marked this conversation as resolved.
}


/**
* Check if a given object implements the ModelApiResponse interface.
Expand Down Expand Up @@ -79,20 +96,3 @@ export function ModelApiResponseToJSONTyped(value?: ModelApiResponse | null, ign
};
}

export const ModelApiResponsePropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
}

44 changes: 22 additions & 22 deletions samples/client/petstore/typescript-fetch/builds/validation-attributes/models/Order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,28 @@ export const OrderStatusEnum = {
} as const;
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];

export const OrderPropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
}

export const OrderAdditionalPropertiesValidationAttributes: { maxProperties?: number, minProperties?: number } = {
maxProperties: 10,
minProperties: 2,
}


/**
* Check if a given object implements the Order interface.
Expand Down Expand Up @@ -118,25 +140,3 @@ export function OrderToJSONTyped(value?: Order | null, ignoreDiscriminator: bool
};
}

export const OrderPropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
}

export const OrderAdditionalPropertiesValidationAttributes: { maxProperties?: number, minProperties?: number } = {
maxProperties: 10,
minProperties: 2,
}

44 changes: 22 additions & 22 deletions samples/client/petstore/typescript-fetch/builds/validation-attributes/models/Pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,28 @@ export const PetStatusEnum = {
} as const;
export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum];

export const PetPropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
photoUrls: {
maxItems: 8,
minItems: 1,
uniqueItems: true,
},
}


/**
* Check if a given object implements the Pet interface.
Expand Down Expand Up @@ -133,25 +155,3 @@ export function PetToJSONTyped(value?: Pet | null, ignoreDiscriminator: boolean
};
}

export const PetPropertyValidationAttributesMap: {
[property: string]: {
maxLength?: number,
minLength?: number,
pattern?: string,
maximum?: number,
exclusiveMaximum?: boolean,
minimum?: number,
exclusiveMinimum?: boolean,
multipleOf?: number,
maxItems?: number,
minItems?: number,
uniqueItems?: boolean
}
} = {
photoUrls: {
maxItems: 8,
minItems: 1,
uniqueItems: true,
},
}

Loading
Loading