Option parity
Which configuration options each of the four generators accepts, side by side, generated from their configuration schemas. Use it to see what changes when you move a configuration from one generator to another; the per-generator pages (TypeScript, Zod, Playwright and k6) describe each option in full.
How to read a cell: for an option with a fixed set of values the cell lists the values and marks the default in bold (no bold means the default is inherited from a top-level option); for other options the cell shows the default, or the type when nothing is applied by default; required marks an option every entry must set; — means the generator does not have the option. Nested options are written parent.option.
The 16 options every generator takes from the shared base schema are batchSize, defaultNullable, fileHeader, includeDescriptions, input, name, operationFilters, outputTypes, prefix, refMappings, showStats, showWarnings, stripPathPrefix, stripSchemaPrefix, suffix, useOperationId; the options of the operationFilters object have their own operationFilters.<option> rows. Everything else is specific to one or more generators.
| Option | TypeScript | Zod | Playwright | k6 |
|---|---|---|---|---|
basePath | — | — | string | string |
batchSize | 10 | 10 | 10 | 10 |
cacheSize | — | 1000 | 1000 | — |
customDateTimeFormatRegex | — | string | RegExp | string | RegExp | — |
defaultNullable | false | false | false | false |
emptyObjectBehavior | — | strict, loose, record | strict, loose, record | — |
enumFormat | enum, union, const-object | union, const-object | union, const-object | enum, union, const-object |
fallbackContentTypeParsing | — | — | text, json, body | — |
fileHeader | string[] | string[] | string[] | string[] |
ignoreHeaders | string[] | string[] | string[] | string[] |
includeDescriptions | true | true | true | true |
input | required | required | required | required |
mode | — | strict, normal, loose | strict, normal, loose | — |
name | string | string | string | string |
operationFilters | object | object | object | object |
operationFilters.excludeDeprecated | false | false | false | false |
operationFilters.excludeMethods | string[] | string[] | string[] | string[] |
operationFilters.excludeOperationIds | string[] | string[] | string[] | string[] |
operationFilters.excludePaths | string[] | string[] | string[] | string[] |
operationFilters.excludeStatusCodes | — | — | string[] | — |
operationFilters.excludeTags | string[] | string[] | string[] | string[] |
operationFilters.includeMethods | string[] | string[] | string[] | string[] |
operationFilters.includeOperationIds | string[] | string[] | string[] | string[] |
operationFilters.includePaths | string[] | string[] | string[] | string[] |
operationFilters.includeStatusCodes | — | — | string[] | — |
operationFilters.includeTags | string[] | string[] | string[] | string[] |
output | — | string | string | — |
outputClient | — | — | required | required |
outputService | — | — | string | string |
outputTypes | required | required | required | required |
outputZodSchemas | — | string | string | — |
preferredContentTypes | — | — | ["application/json"] | ["application/json"] |
prefix | string | string | string | string |
refMappings | Record<string, string> | Record<string, string> | Record<string, string> | Record<string, string> |
request | — | object | object | — |
request.defaultNullable | — | the top-level defaultNullable | the top-level defaultNullable | — |
request.emptyObjectBehavior | — | strict, loose, record | strict, loose, record | — |
request.includeDescriptions | — | the top-level includeDescriptions | the top-level includeDescriptions | — |
request.mode | — | strict, normal, loose | strict, normal, loose | — |
request.useDescribe | — | the top-level useDescribe | the top-level useDescribe | — |
response | — | object | object | — |
response.defaultNullable | — | the top-level defaultNullable | the top-level defaultNullable | — |
response.emptyObjectBehavior | — | strict, loose, record | strict, loose, record | — |
response.includeDescriptions | — | the top-level includeDescriptions | the top-level includeDescriptions | — |
response.mode | — | strict, normal, loose | strict, normal, loose | — |
response.useDescribe | — | the top-level useDescribe | the top-level useDescribe | — |
schemaType | all, request, response | all, request, response | — | — |
showStats | true | true | true | true |
showWarnings | true | true | true | true |
stripPathPrefix | string | string | string | string |
stripSchemaPrefix | string | string[] | string | string[] | string | string[] | string | string[] |
suffix | string | string | string | string |
typeAssertionThreshold | — | 0 | 0 | — |
useDescribe | — | false | false | — |
useOperationId | true | true | false | false |
uuidFormat | — | uuid, guid, uuidv1, uuidv2, uuidv3, uuidv4, uuidv5, uuidv6, uuidv7, uuidv8 | uuid, guid, uuidv1, uuidv2, uuidv3, uuidv4, uuidv5, uuidv6, uuidv7, uuidv8 | — |
validateServiceRequest | — | — | false | — |
zodErrorFormat | — | — | standard, prettify, prettifyWithValues | — |