+5

.changeset/quiet-seals-pay.md

··· 1 1 + --- 2 2 + "@hey-api/openapi-ts": minor 3 3 + --- 4 4 + 5 5 + feat: add form type option for schemas

+13 -1

docs/openapi-ts/configuration.md

··· 174 174 } 175 175 ``` 176 176 177 177 - If you're using OpenAPI v3.1, your schemas are JSON Schema compliant and can be used with any other tools supporting JSON Schema. However, if you don't need schemas at all, you can disable them with 177 177 + If you're using OpenAPI v3.1, your schemas are JSON Schema compliant and can be used with other tools supporting JSON Schema. However, if you only want to validate form input, you don't want to include string descriptions inside your bundle. Instead, use `form` type. 178 178 + 179 179 + ```js{5} 180 180 + export default { 181 181 + input: 'path/to/openapi.json', 182 182 + output: 'src/client', 183 183 + schemas: { 184 184 + type: 'form' 185 185 + }, 186 186 + } 187 187 + ``` 188 188 + 189 189 + If you don't need schemas at all, you can disable them with 178 190 179 191 ```js{4} 180 192 export default {

+17 -1

packages/openapi-ts/src/index.ts

··· 88 88 } 89 89 }; 90 90 91 91 + const getSchemas = (userConfig: UserConfig): Config['schemas'] => { 92 92 + let schemas: Config['schemas'] = { 93 93 + export: true, 94 94 + type: 'json', 95 95 + }; 96 96 + if (typeof userConfig.schemas === 'boolean') { 97 97 + schemas.export = userConfig.schemas; 98 98 + } else { 99 99 + schemas = { 100 100 + ...schemas, 101 101 + ...userConfig.schemas, 102 102 + }; 103 103 + } 104 104 + return schemas; 105 105 + }; 106 106 + 91 107 const getServices = (userConfig: UserConfig): Config['services'] => { 92 108 let services: Config['services'] = { 93 109 export: true, ··· 152 168 name, 153 169 operationId = true, 154 170 request, 155 155 - schemas = true, 156 171 serviceResponse = 'body', 157 172 useDateType = false, 158 173 useOptions = true, ··· 182 197 183 198 const client = userConfig.client || inferClient(dependencies); 184 199 const output = path.resolve(process.cwd(), userConfig.output); 200 200 + const schemas = getSchemas(userConfig); 185 201 const services = getServices(userConfig); 186 202 const types = getTypes(userConfig); 187 203

+6 -2

packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts

··· 19 19 lint: false, 20 20 operationId: true, 21 21 output: '', 22 22 - schemas: false, 22 22 + schemas: { 23 23 + export: false, 24 24 + }, 23 25 serviceResponse: 'body', 24 26 services: { 25 27 export: false, ··· 42 44 lint: false, 43 45 operationId: false, 44 46 output: '', 45 45 - schemas: false, 47 47 + schemas: { 48 48 + export: false, 49 49 + }, 46 50 serviceResponse: 'body', 47 51 services: { 48 52 export: false,

+1 -1

packages/openapi-ts/src/openApi/v2/parser/__tests__/getServices.spec.ts

··· 16 16 lint: false, 17 17 operationId: false, 18 18 output: '', 19 19 - schemas: true, 19 19 + schemas: {}, 20 20 serviceResponse: 'body', 21 21 services: {}, 22 22 types: {},

+1 -1

packages/openapi-ts/src/openApi/v3/parser/__tests__/getServices.spec.ts

··· 16 16 lint: false, 17 17 operationId: true, 18 18 output: '', 19 19 - schemas: true, 19 19 + schemas: {}, 20 20 serviceResponse: 'body', 21 21 services: {}, 22 22 types: {},

+19 -3

packages/openapi-ts/src/types/config.ts

··· 60 60 */ 61 61 request?: string; 62 62 /** 63 63 - * Export JSON schemas? 63 63 + * Generate JSON schemas? 64 64 * @default true 65 65 */ 66 66 - schemas?: boolean; 66 66 + schemas?: 67 67 + | boolean 68 68 + | { 69 69 + /** 70 70 + * Generate JSON schemas? 71 71 + * @default true 72 72 + */ 73 73 + export?: boolean; 74 74 + /** 75 75 + * Choose schema type to generate. Select 'form' if you don't want 76 76 + * descriptions to reduce bundle size and you plan to use schemas 77 77 + * for form validation 78 78 + * @default 'json' 79 79 + */ 80 80 + type?: 'form' | 'json'; 81 81 + }; 67 82 /** 68 83 * Define shape of returned value from service calls 69 84 * @default 'body' ··· 129 144 130 145 export type Config = Omit< 131 146 Required<UserConfig>, 132 132 - 'base' | 'name' | 'request' | 'services' | 'types' 147 147 + 'base' | 'name' | 'request' | 'schemas' | 'services' | 'types' 133 148 > & 134 149 Pick<UserConfig, 'base' | 'name' | 'request'> & { 150 150 + schemas: Extract<Required<UserConfig>['schemas'], object>; 135 151 services: Extract<Required<UserConfig>['services'], object>; 136 152 types: Extract<Required<UserConfig>['types'], object>; 137 153 };

+2 -2

packages/openapi-ts/src/utils/__tests__/handlebars.spec.ts

··· 20 20 lint: false, 21 21 operationId: true, 22 22 output: '', 23 23 - schemas: true, 23 23 + schemas: {}, 24 24 serviceResponse: 'body', 25 25 services: {}, 26 26 types: {}, ··· 50 50 lint: false, 51 51 operationId: true, 52 52 output: '', 53 53 - schemas: true, 53 53 + schemas: {}, 54 54 serviceResponse: 'body', 55 55 services: {}, 56 56 types: {},

+1 -1

packages/openapi-ts/src/utils/write/__tests__/class.spec.ts

··· 23 23 name: 'AppClient', 24 24 operationId: true, 25 25 output: '', 26 26 - schemas: true, 26 26 + schemas: {}, 27 27 serviceResponse: 'body', 28 28 services: {}, 29 29 types: {},

+1 -1

packages/openapi-ts/src/utils/write/__tests__/client.spec.ts

··· 22 22 lint: false, 23 23 operationId: true, 24 24 output: './dist', 25 25 - schemas: true, 25 25 + schemas: {}, 26 26 serviceResponse: 'body', 27 27 services: {}, 28 28 types: {},

+3 -3

packages/openapi-ts/src/utils/write/__tests__/core.spec.ts

··· 37 37 name: 'AppClient', 38 38 operationId: true, 39 39 output: '', 40 40 - schemas: true, 40 40 + schemas: {}, 41 41 serviceResponse: 'body', 42 42 services: {}, 43 43 types: {}, ··· 94 94 name: 'AppClient', 95 95 operationId: true, 96 96 output: '', 97 97 - schemas: true, 97 97 + schemas: {}, 98 98 serviceResponse: 'body', 99 99 services: {}, 100 100 types: {}, ··· 134 134 name: 'AppClient', 135 135 operationId: true, 136 136 output: '', 137 137 - schemas: true, 137 137 + schemas: {}, 138 138 serviceResponse: 'body', 139 139 services: {}, 140 140 types: {},

+1 -1

packages/openapi-ts/src/utils/write/__tests__/index.spec.ts

··· 22 22 lint: false, 23 23 operationId: true, 24 24 output: '', 25 25 - schemas: true, 25 25 + schemas: {}, 26 26 serviceResponse: 'body', 27 27 services: {}, 28 28 types: {},

+1 -1

packages/openapi-ts/src/utils/write/__tests__/models.spec.ts

··· 23 23 name: 'AppClient', 24 24 operationId: true, 25 25 output: '', 26 26 - schemas: true, 26 26 + schemas: {}, 27 27 serviceResponse: 'body', 28 28 services: {}, 29 29 types: {},

+1 -1

packages/openapi-ts/src/utils/write/__tests__/schemas.spec.ts

··· 24 24 name: 'AppClient', 25 25 operationId: true, 26 26 output: '', 27 27 - schemas: true, 27 27 + schemas: {}, 28 28 serviceResponse: 'body', 29 29 services: {}, 30 30 types: {},

+1 -1

packages/openapi-ts/src/utils/write/__tests__/services.spec.ts

··· 22 22 lint: false, 23 23 operationId: true, 24 24 output: '', 25 25 - schemas: true, 25 25 + schemas: {}, 26 26 serviceResponse: 'body', 27 27 services: {}, 28 28 types: {},

+1 -1

packages/openapi-ts/src/utils/write/client.ts

··· 56 56 name: 'enums.ts', 57 57 }); 58 58 } 59 59 - if (config.schemas) { 59 59 + if (config.schemas.export) { 60 60 files.schemas = new TypeScriptFile({ 61 61 dir: config.output, 62 62 name: 'schemas.ts',

+38 -1

packages/openapi-ts/src/utils/write/schemas.ts

··· 1 1 import { compiler, TypeScriptFile } from '../../compiler'; 2 2 import type { OpenApi } from '../../openApi'; 3 3 import { ensureValidTypeScriptJavaScriptIdentifier } from '../../openApi/common/parser/sanitize'; 4 4 + import { getConfig } from '../config'; 5 5 + 6 6 + const schemaToFormSchema = (schema: unknown): object => { 7 7 + if (Array.isArray(schema)) { 8 8 + return schema.map((item) => schemaToFormSchema(item)); 9 9 + } 10 10 + 11 11 + if (typeof schema !== 'object' || schema === null) { 12 12 + return schema as object; 13 13 + } 14 14 + 15 15 + const result = { ...schema }; 16 16 + Object.entries(result).forEach(([key, value]) => { 17 17 + if ( 18 18 + [ 19 19 + 'description', 20 20 + 'x-enum-descriptions', 21 21 + 'x-enum-varnames', 22 22 + 'x-enumNames', 23 23 + ].includes(key) 24 24 + ) { 25 25 + // @ts-ignore 26 26 + delete result[key]; 27 27 + return; 28 28 + } 29 29 + 30 30 + if (value && typeof value === 'object') { 31 31 + // @ts-ignore 32 32 + result[key] = schemaToFormSchema(value); 33 33 + } 34 34 + }); 35 35 + return result; 36 36 + }; 4 37 5 38 export const processSchemas = async ({ 6 39 file, ··· 13 46 return; 14 47 } 15 48 16 16 - const addSchema = (name: string, obj: any) => { 49 49 + const config = getConfig(); 50 50 + 51 51 + const addSchema = (name: string, schema: object) => { 17 52 const validName = `$${ensureValidTypeScriptJavaScriptIdentifier(name)}`; 53 53 + const obj = 54 54 + config.schemas.type === 'form' ? schemaToFormSchema(schema) : schema; 18 55 const expression = compiler.types.object({ obj }); 19 56 const statement = compiler.export.asConst(validName, expression); 20 57 file.add(statement);

+3

packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/index.ts.snap

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export * from './schemas.gen';

+1552

packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/schemas.gen.ts.snap

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export const $camelCaseCommentWithBreaks = { 4 4 + type: 'integer', 5 5 + } as const; 6 6 + 7 7 + export const $CommentWithBreaks = { 8 8 + type: 'integer', 9 9 + } as const; 10 10 + 11 11 + export const $CommentWithBackticks = { 12 12 + type: 'integer', 13 13 + } as const; 14 14 + 15 15 + export const $CommentWithBackticksAndQuotes = { 16 16 + type: 'integer', 17 17 + } as const; 18 18 + 19 19 + export const $CommentWithSlashes = { 20 20 + type: 'integer', 21 21 + } as const; 22 22 + 23 23 + export const $CommentWithExpressionPlaceholders = { 24 24 + type: 'integer', 25 25 + } as const; 26 26 + 27 27 + export const $CommentWithQuotes = { 28 28 + type: 'integer', 29 29 + } as const; 30 30 + 31 31 + export const $CommentWithReservedCharacters = { 32 32 + type: 'integer', 33 33 + } as const; 34 34 + 35 35 + export const $SimpleInteger = { 36 36 + type: 'integer', 37 37 + } as const; 38 38 + 39 39 + export const $SimpleBoolean = { 40 40 + type: 'boolean', 41 41 + } as const; 42 42 + 43 43 + export const $SimpleString = { 44 44 + type: 'string', 45 45 + } as const; 46 46 + 47 47 + export const $NonAsciiStringæøåÆØÅöôêÊ字符串 = { 48 48 + type: 'string', 49 49 + } as const; 50 50 + 51 51 + export const $SimpleFile = { 52 52 + type: 'file', 53 53 + } as const; 54 54 + 55 55 + export const $SimpleReference = { 56 56 + $ref: '#/components/schemas/ModelWithString', 57 57 + } as const; 58 58 + 59 59 + export const $SimpleStringWithPattern = { 60 60 + type: 'string', 61 61 + nullable: true, 62 62 + maxLength: 64, 63 63 + pattern: '^[a-zA-Z0-9_]*$', 64 64 + } as const; 65 65 + 66 66 + export const $EnumWithStrings = { 67 67 + enum: [ 68 68 + 'Success', 69 69 + 'Warning', 70 70 + 'Error', 71 71 + "'Single Quote'", 72 72 + '"Double Quotes"', 73 73 + 'Non-ascii: øæåôöØÆÅÔÖ字符串', 74 74 + ], 75 75 + } as const; 76 76 + 77 77 + export const $EnumWithReplacedCharacters = { 78 78 + enum: ["'Single Quote'", '"Double Quotes"', 'øæåôöØÆÅÔÖ字符串', 3.1, ''], 79 79 + type: 'string', 80 80 + } as const; 81 81 + 82 82 + export const $EnumWithNumbers = { 83 83 + enum: [ 84 84 + 1, 2, 3, 1.1, 1.2, 1.3, 100, 200, 300, -100, -200, -300, -1.1, -1.2, -1.3, 85 85 + ], 86 86 + default: 200, 87 87 + } as const; 88 88 + 89 89 + export const $EnumFromDescription = { 90 90 + type: 'number', 91 91 + } as const; 92 92 + 93 93 + export const $EnumWithExtensions = { 94 94 + enum: [200, 400, 500], 95 95 + } as const; 96 96 + 97 97 + export const $EnumWithXEnumNames = { 98 98 + enum: [0, 1, 2], 99 99 + } as const; 100 100 + 101 101 + export const $ArrayWithNumbers = { 102 102 + type: 'array', 103 103 + items: { 104 104 + type: 'integer', 105 105 + }, 106 106 + } as const; 107 107 + 108 108 + export const $ArrayWithBooleans = { 109 109 + type: 'array', 110 110 + items: { 111 111 + type: 'boolean', 112 112 + }, 113 113 + } as const; 114 114 + 115 115 + export const $ArrayWithStrings = { 116 116 + type: 'array', 117 117 + items: { 118 118 + type: 'string', 119 119 + }, 120 120 + default: ['test'], 121 121 + } as const; 122 122 + 123 123 + export const $ArrayWithReferences = { 124 124 + type: 'array', 125 125 + items: { 126 126 + $ref: '#/components/schemas/ModelWithString', 127 127 + }, 128 128 + } as const; 129 129 + 130 130 + export const $ArrayWithArray = { 131 131 + type: 'array', 132 132 + items: { 133 133 + type: 'array', 134 134 + items: { 135 135 + $ref: '#/components/schemas/ModelWithString', 136 136 + }, 137 137 + }, 138 138 + } as const; 139 139 + 140 140 + export const $ArrayWithProperties = { 141 141 + type: 'array', 142 142 + items: { 143 143 + type: 'object', 144 144 + properties: { 145 145 + foo: { 146 146 + $ref: '#/components/schemas/camelCaseCommentWithBreaks', 147 147 + }, 148 148 + bar: { 149 149 + type: 'string', 150 150 + }, 151 151 + }, 152 152 + }, 153 153 + } as const; 154 154 + 155 155 + export const $ArrayWithAnyOfProperties = { 156 156 + type: 'array', 157 157 + items: { 158 158 + anyOf: [ 159 159 + { 160 160 + type: 'object', 161 161 + properties: { 162 162 + foo: { 163 163 + type: 'string', 164 164 + default: 'test', 165 165 + }, 166 166 + }, 167 167 + }, 168 168 + { 169 169 + type: 'object', 170 170 + properties: { 171 171 + bar: { 172 172 + type: 'string', 173 173 + }, 174 174 + }, 175 175 + }, 176 176 + ], 177 177 + }, 178 178 + } as const; 179 179 + 180 180 + export const $AnyOfAnyAndNull = { 181 181 + type: 'object', 182 182 + properties: { 183 183 + data: { 184 184 + anyOf: [ 185 185 + {}, 186 186 + { 187 187 + type: 'null', 188 188 + }, 189 189 + ], 190 190 + }, 191 191 + }, 192 192 + } as const; 193 193 + 194 194 + export const $AnyOfArrays = { 195 195 + type: 'object', 196 196 + properties: { 197 197 + results: { 198 198 + items: { 199 199 + anyOf: [ 200 200 + { 201 201 + type: 'object', 202 202 + properties: { 203 203 + foo: { 204 204 + type: 'string', 205 205 + }, 206 206 + }, 207 207 + }, 208 208 + { 209 209 + type: 'object', 210 210 + properties: { 211 211 + bar: { 212 212 + type: 'string', 213 213 + }, 214 214 + }, 215 215 + }, 216 216 + ], 217 217 + }, 218 218 + type: 'array', 219 219 + }, 220 220 + }, 221 221 + } as const; 222 222 + 223 223 + export const $DictionaryWithString = { 224 224 + type: 'object', 225 225 + additionalProperties: { 226 226 + type: 'string', 227 227 + }, 228 228 + } as const; 229 229 + 230 230 + export const $DictionaryWithPropertiesAndAdditionalProperties = { 231 231 + type: 'object', 232 232 + properties: { 233 233 + foo: { 234 234 + type: 'string', 235 235 + }, 236 236 + }, 237 237 + additionalProperties: { 238 238 + type: 'string', 239 239 + }, 240 240 + } as const; 241 241 + 242 242 + export const $DictionaryWithReference = { 243 243 + type: 'object', 244 244 + additionalProperties: { 245 245 + $ref: '#/components/schemas/ModelWithString', 246 246 + }, 247 247 + } as const; 248 248 + 249 249 + export const $DictionaryWithArray = { 250 250 + type: 'object', 251 251 + additionalProperties: { 252 252 + type: 'array', 253 253 + items: { 254 254 + $ref: '#/components/schemas/ModelWithString', 255 255 + }, 256 256 + }, 257 257 + } as const; 258 258 + 259 259 + export const $DictionaryWithDictionary = { 260 260 + type: 'object', 261 261 + additionalProperties: { 262 262 + type: 'object', 263 263 + additionalProperties: { 264 264 + type: 'string', 265 265 + }, 266 266 + }, 267 267 + } as const; 268 268 + 269 269 + export const $DictionaryWithProperties = { 270 270 + type: 'object', 271 271 + additionalProperties: { 272 272 + type: 'object', 273 273 + properties: { 274 274 + foo: { 275 275 + type: 'string', 276 276 + }, 277 277 + bar: { 278 278 + type: 'string', 279 279 + }, 280 280 + }, 281 281 + }, 282 282 + } as const; 283 283 + 284 284 + export const $ModelWithInteger = { 285 285 + type: 'object', 286 286 + properties: { 287 287 + prop: { 288 288 + type: 'integer', 289 289 + }, 290 290 + }, 291 291 + } as const; 292 292 + 293 293 + export const $ModelWithBoolean = { 294 294 + type: 'object', 295 295 + properties: { 296 296 + prop: { 297 297 + type: 'boolean', 298 298 + }, 299 299 + }, 300 300 + } as const; 301 301 + 302 302 + export const $ModelWithString = { 303 303 + type: 'object', 304 304 + properties: { 305 305 + prop: { 306 306 + type: 'string', 307 307 + }, 308 308 + }, 309 309 + } as const; 310 310 + 311 311 + export const $Model_From_Zendesk = { 312 312 + type: 'string', 313 313 + } as const; 314 314 + 315 315 + export const $ModelWithNullableString = { 316 316 + type: 'object', 317 317 + required: ['nullableRequiredProp1', 'nullableRequiredProp2'], 318 318 + properties: { 319 319 + nullableProp1: { 320 320 + type: 'string', 321 321 + nullable: true, 322 322 + }, 323 323 + nullableRequiredProp1: { 324 324 + type: 'string', 325 325 + nullable: true, 326 326 + }, 327 327 + nullableProp2: { 328 328 + type: ['string', 'null'], 329 329 + }, 330 330 + nullableRequiredProp2: { 331 331 + type: ['string', 'null'], 332 332 + }, 333 333 + 'foo_bar-enum': { 334 334 + enum: ['Success', 'Warning', 'Error', 'ØÆÅ字符串'], 335 335 + }, 336 336 + }, 337 337 + } as const; 338 338 + 339 339 + export const $ModelWithEnum = { 340 340 + type: 'object', 341 341 + properties: { 342 342 + 'foo_bar-enum': { 343 343 + enum: ['Success', 'Warning', 'Error', 'ØÆÅ字符串'], 344 344 + }, 345 345 + statusCode: { 346 346 + enum: [ 347 347 + '100', 348 348 + '200 FOO', 349 349 + '300 FOO_BAR', 350 350 + '400 foo-bar', 351 351 + '500 foo.bar', 352 352 + '600 foo&bar', 353 353 + ], 354 354 + }, 355 355 + bool: { 356 356 + type: 'boolean', 357 357 + enum: [true], 358 358 + }, 359 359 + }, 360 360 + } as const; 361 361 + 362 362 + export const $ModelWithEnumWithHyphen = { 363 363 + type: 'object', 364 364 + properties: { 365 365 + 'foo-bar-baz-qux': { 366 366 + type: 'string', 367 367 + enum: ['3.0'], 368 368 + title: 'Foo-Bar-Baz-Qux', 369 369 + default: '3.0', 370 370 + }, 371 371 + }, 372 372 + } as const; 373 373 + 374 374 + export const $ModelWithEnumFromDescription = { 375 375 + type: 'object', 376 376 + properties: { 377 377 + test: { 378 378 + type: 'integer', 379 379 + }, 380 380 + }, 381 381 + } as const; 382 382 + 383 383 + export const $ModelWithNestedEnums = { 384 384 + type: 'object', 385 385 + properties: { 386 386 + dictionaryWithEnum: { 387 387 + type: 'object', 388 388 + additionalProperties: { 389 389 + enum: ['Success', 'Warning', 'Error'], 390 390 + }, 391 391 + }, 392 392 + dictionaryWithEnumFromDescription: { 393 393 + type: 'object', 394 394 + additionalProperties: { 395 395 + type: 'integer', 396 396 + }, 397 397 + }, 398 398 + arrayWithEnum: { 399 399 + type: 'array', 400 400 + items: { 401 401 + enum: ['Success', 'Warning', 'Error'], 402 402 + }, 403 403 + }, 404 404 + arrayWithDescription: { 405 405 + type: 'array', 406 406 + items: { 407 407 + type: 'integer', 408 408 + }, 409 409 + }, 410 410 + 'foo_bar-enum': { 411 411 + enum: ['Success', 'Warning', 'Error', 'ØÆÅ字符串'], 412 412 + }, 413 413 + }, 414 414 + } as const; 415 415 + 416 416 + export const $ModelWithReference = { 417 417 + type: 'object', 418 418 + properties: { 419 419 + prop: { 420 420 + $ref: '#/components/schemas/ModelWithProperties', 421 421 + }, 422 422 + }, 423 423 + } as const; 424 424 + 425 425 + export const $ModelWithArrayReadOnlyAndWriteOnly = { 426 426 + type: 'object', 427 427 + properties: { 428 428 + prop: { 429 429 + type: 'array', 430 430 + items: { 431 431 + $ref: '#/components/schemas/ModelWithReadOnlyAndWriteOnly', 432 432 + }, 433 433 + }, 434 434 + propWithFile: { 435 435 + type: 'array', 436 436 + items: { 437 437 + type: 'file', 438 438 + }, 439 439 + }, 440 440 + propWithNumber: { 441 441 + type: 'array', 442 442 + items: { 443 443 + type: 'number', 444 444 + }, 445 445 + }, 446 446 + }, 447 447 + } as const; 448 448 + 449 449 + export const $ModelWithArray = { 450 450 + type: 'object', 451 451 + properties: { 452 452 + prop: { 453 453 + type: 'array', 454 454 + items: { 455 455 + $ref: '#/components/schemas/ModelWithString', 456 456 + }, 457 457 + }, 458 458 + propWithFile: { 459 459 + type: 'array', 460 460 + items: { 461 461 + type: 'file', 462 462 + }, 463 463 + }, 464 464 + propWithNumber: { 465 465 + type: 'array', 466 466 + items: { 467 467 + type: 'number', 468 468 + }, 469 469 + }, 470 470 + }, 471 471 + } as const; 472 472 + 473 473 + export const $ModelWithDictionary = { 474 474 + type: 'object', 475 475 + properties: { 476 476 + prop: { 477 477 + type: 'object', 478 478 + additionalProperties: { 479 479 + type: 'string', 480 480 + }, 481 481 + }, 482 482 + }, 483 483 + } as const; 484 484 + 485 485 + export const $DeprecatedModel = { 486 486 + deprecated: true, 487 487 + type: 'object', 488 488 + properties: { 489 489 + prop: { 490 490 + deprecated: true, 491 491 + type: 'string', 492 492 + }, 493 493 + }, 494 494 + } as const; 495 495 + 496 496 + export const $ModelWithCircularReference = { 497 497 + type: 'object', 498 498 + properties: { 499 499 + prop: { 500 500 + $ref: '#/components/schemas/ModelWithCircularReference', 501 501 + }, 502 502 + }, 503 503 + } as const; 504 504 + 505 505 + export const $CompositionWithOneOf = { 506 506 + type: 'object', 507 507 + properties: { 508 508 + propA: { 509 509 + type: 'object', 510 510 + oneOf: [ 511 511 + { 512 512 + $ref: '#/components/schemas/ModelWithString', 513 513 + }, 514 514 + { 515 515 + $ref: '#/components/schemas/ModelWithEnum', 516 516 + }, 517 517 + { 518 518 + $ref: '#/components/schemas/ModelWithArray', 519 519 + }, 520 520 + { 521 521 + $ref: '#/components/schemas/ModelWithDictionary', 522 522 + }, 523 523 + ], 524 524 + }, 525 525 + }, 526 526 + } as const; 527 527 + 528 528 + export const $CompositionWithOneOfAnonymous = { 529 529 + type: 'object', 530 530 + properties: { 531 531 + propA: { 532 532 + type: 'object', 533 533 + oneOf: [ 534 534 + { 535 535 + type: 'object', 536 536 + properties: { 537 537 + propA: { 538 538 + type: 'string', 539 539 + }, 540 540 + }, 541 541 + }, 542 542 + { 543 543 + type: 'string', 544 544 + }, 545 545 + { 546 546 + type: 'integer', 547 547 + }, 548 548 + ], 549 549 + }, 550 550 + }, 551 551 + } as const; 552 552 + 553 553 + export const $ModelCircle = { 554 554 + type: 'object', 555 555 + required: ['kind'], 556 556 + properties: { 557 557 + kind: { 558 558 + type: 'string', 559 559 + }, 560 560 + radius: { 561 561 + type: 'number', 562 562 + }, 563 563 + }, 564 564 + } as const; 565 565 + 566 566 + export const $ModelSquare = { 567 567 + type: 'object', 568 568 + required: ['kind'], 569 569 + properties: { 570 570 + kind: { 571 571 + type: 'string', 572 572 + }, 573 573 + sideLength: { 574 574 + type: 'number', 575 575 + }, 576 576 + }, 577 577 + } as const; 578 578 + 579 579 + export const $CompositionWithOneOfDiscriminator = { 580 580 + type: 'object', 581 581 + oneOf: [ 582 582 + { 583 583 + $ref: '#/components/schemas/ModelCircle', 584 584 + }, 585 585 + { 586 586 + $ref: '#/components/schemas/ModelSquare', 587 587 + }, 588 588 + ], 589 589 + discriminator: { 590 590 + propertyName: 'kind', 591 591 + mapping: { 592 592 + circle: '#/components/schemas/ModelCircle', 593 593 + square: '#/components/schemas/ModelSquare', 594 594 + }, 595 595 + }, 596 596 + } as const; 597 597 + 598 598 + export const $CompositionWithAnyOf = { 599 599 + type: 'object', 600 600 + properties: { 601 601 + propA: { 602 602 + type: 'object', 603 603 + anyOf: [ 604 604 + { 605 605 + $ref: '#/components/schemas/ModelWithString', 606 606 + }, 607 607 + { 608 608 + $ref: '#/components/schemas/ModelWithEnum', 609 609 + }, 610 610 + { 611 611 + $ref: '#/components/schemas/ModelWithArray', 612 612 + }, 613 613 + { 614 614 + $ref: '#/components/schemas/ModelWithDictionary', 615 615 + }, 616 616 + ], 617 617 + }, 618 618 + }, 619 619 + } as const; 620 620 + 621 621 + export const $CompositionWithAnyOfAnonymous = { 622 622 + type: 'object', 623 623 + properties: { 624 624 + propA: { 625 625 + type: 'object', 626 626 + anyOf: [ 627 627 + { 628 628 + type: 'object', 629 629 + properties: { 630 630 + propA: { 631 631 + type: 'string', 632 632 + }, 633 633 + }, 634 634 + }, 635 635 + { 636 636 + type: 'string', 637 637 + }, 638 638 + { 639 639 + type: 'integer', 640 640 + }, 641 641 + ], 642 642 + }, 643 643 + }, 644 644 + } as const; 645 645 + 646 646 + export const $CompositionWithNestedAnyAndTypeNull = { 647 647 + type: 'object', 648 648 + properties: { 649 649 + propA: { 650 650 + type: 'object', 651 651 + anyOf: [ 652 652 + { 653 653 + items: { 654 654 + anyOf: [ 655 655 + { 656 656 + $ref: '#/components/schemas/ModelWithDictionary', 657 657 + }, 658 658 + { 659 659 + type: 'null', 660 660 + }, 661 661 + ], 662 662 + }, 663 663 + type: 'array', 664 664 + }, 665 665 + { 666 666 + items: { 667 667 + anyOf: [ 668 668 + { 669 669 + $ref: '#/components/schemas/ModelWithArray', 670 670 + }, 671 671 + { 672 672 + type: 'null', 673 673 + }, 674 674 + ], 675 675 + }, 676 676 + type: 'array', 677 677 + }, 678 678 + ], 679 679 + }, 680 680 + }, 681 681 + } as const; 682 682 + 683 683 + export const $Enum1 = { 684 684 + enum: ['Bird', 'Dog'], 685 685 + type: 'string', 686 686 + } as const; 687 687 + 688 688 + export const $ConstValue = { 689 689 + type: 'string', 690 690 + const: 'ConstValue', 691 691 + } as const; 692 692 + 693 693 + export const $CompositionWithNestedAnyOfAndNull = { 694 694 + type: 'object', 695 695 + properties: { 696 696 + propA: { 697 697 + anyOf: [ 698 698 + { 699 699 + items: { 700 700 + anyOf: [ 701 701 + { 702 702 + $ref: '#/components/schemas/Enum1', 703 703 + }, 704 704 + { 705 705 + $ref: '#/components/schemas/ConstValue', 706 706 + }, 707 707 + ], 708 708 + }, 709 709 + type: 'array', 710 710 + }, 711 711 + { 712 712 + type: 'null', 713 713 + }, 714 714 + ], 715 715 + title: 'Scopes', 716 716 + }, 717 717 + }, 718 718 + } as const; 719 719 + 720 720 + export const $CompositionWithOneOfAndNullable = { 721 721 + type: 'object', 722 722 + properties: { 723 723 + propA: { 724 724 + nullable: true, 725 725 + type: 'object', 726 726 + oneOf: [ 727 727 + { 728 728 + type: 'object', 729 729 + properties: { 730 730 + boolean: { 731 731 + type: 'boolean', 732 732 + }, 733 733 + }, 734 734 + }, 735 735 + { 736 736 + $ref: '#/components/schemas/ModelWithEnum', 737 737 + }, 738 738 + { 739 739 + $ref: '#/components/schemas/ModelWithArray', 740 740 + }, 741 741 + { 742 742 + $ref: '#/components/schemas/ModelWithDictionary', 743 743 + }, 744 744 + ], 745 745 + }, 746 746 + }, 747 747 + } as const; 748 748 + 749 749 + export const $CompositionWithOneOfAndSimpleDictionary = { 750 750 + type: 'object', 751 751 + properties: { 752 752 + propA: { 753 753 + oneOf: [ 754 754 + { 755 755 + type: 'boolean', 756 756 + }, 757 757 + { 758 758 + type: 'object', 759 759 + additionalProperties: { 760 760 + type: 'number', 761 761 + }, 762 762 + }, 763 763 + ], 764 764 + }, 765 765 + }, 766 766 + } as const; 767 767 + 768 768 + export const $CompositionWithOneOfAndSimpleArrayDictionary = { 769 769 + type: 'object', 770 770 + properties: { 771 771 + propA: { 772 772 + oneOf: [ 773 773 + { 774 774 + type: 'boolean', 775 775 + }, 776 776 + { 777 777 + type: 'object', 778 778 + additionalProperties: { 779 779 + type: 'array', 780 780 + items: { 781 781 + type: 'boolean', 782 782 + }, 783 783 + }, 784 784 + }, 785 785 + ], 786 786 + }, 787 787 + }, 788 788 + } as const; 789 789 + 790 790 + export const $CompositionWithOneOfAndComplexArrayDictionary = { 791 791 + type: 'object', 792 792 + properties: { 793 793 + propA: { 794 794 + oneOf: [ 795 795 + { 796 796 + type: 'boolean', 797 797 + }, 798 798 + { 799 799 + type: 'object', 800 800 + additionalProperties: { 801 801 + type: 'array', 802 802 + items: { 803 803 + oneOf: [ 804 804 + { 805 805 + type: 'number', 806 806 + }, 807 807 + { 808 808 + type: 'string', 809 809 + }, 810 810 + ], 811 811 + }, 812 812 + }, 813 813 + }, 814 814 + ], 815 815 + }, 816 816 + }, 817 817 + } as const; 818 818 + 819 819 + export const $CompositionWithAllOfAndNullable = { 820 820 + type: 'object', 821 821 + properties: { 822 822 + propA: { 823 823 + nullable: true, 824 824 + type: 'object', 825 825 + allOf: [ 826 826 + { 827 827 + type: 'object', 828 828 + properties: { 829 829 + boolean: { 830 830 + type: 'boolean', 831 831 + }, 832 832 + }, 833 833 + }, 834 834 + { 835 835 + $ref: '#/components/schemas/ModelWithEnum', 836 836 + }, 837 837 + { 838 838 + $ref: '#/components/schemas/ModelWithArray', 839 839 + }, 840 840 + { 841 841 + $ref: '#/components/schemas/ModelWithDictionary', 842 842 + }, 843 843 + ], 844 844 + }, 845 845 + }, 846 846 + } as const; 847 847 + 848 848 + export const $CompositionWithAnyOfAndNullable = { 849 849 + type: 'object', 850 850 + properties: { 851 851 + propA: { 852 852 + nullable: true, 853 853 + type: 'object', 854 854 + anyOf: [ 855 855 + { 856 856 + type: 'object', 857 857 + properties: { 858 858 + boolean: { 859 859 + type: 'boolean', 860 860 + }, 861 861 + }, 862 862 + }, 863 863 + { 864 864 + $ref: '#/components/schemas/ModelWithEnum', 865 865 + }, 866 866 + { 867 867 + $ref: '#/components/schemas/ModelWithArray', 868 868 + }, 869 869 + { 870 870 + $ref: '#/components/schemas/ModelWithDictionary', 871 871 + }, 872 872 + ], 873 873 + }, 874 874 + }, 875 875 + } as const; 876 876 + 877 877 + export const $CompositionBaseModel = { 878 878 + type: 'object', 879 879 + properties: { 880 880 + firstName: { 881 881 + type: 'string', 882 882 + }, 883 883 + lastname: { 884 884 + type: 'string', 885 885 + }, 886 886 + }, 887 887 + } as const; 888 888 + 889 889 + export const $CompositionExtendedModel = { 890 890 + type: 'object', 891 891 + allOf: [ 892 892 + { 893 893 + $ref: '#/components/schemas/CompositionBaseModel', 894 894 + }, 895 895 + ], 896 896 + properties: { 897 897 + age: { 898 898 + type: 'number', 899 899 + }, 900 900 + }, 901 901 + required: ['firstName', 'lastname', 'age'], 902 902 + } as const; 903 903 + 904 904 + export const $ModelWithProperties = { 905 905 + type: 'object', 906 906 + required: ['required', 'requiredAndReadOnly', 'requiredAndNullable'], 907 907 + properties: { 908 908 + required: { 909 909 + type: 'string', 910 910 + }, 911 911 + requiredAndReadOnly: { 912 912 + type: 'string', 913 913 + readOnly: true, 914 914 + }, 915 915 + requiredAndNullable: { 916 916 + type: 'string', 917 917 + nullable: true, 918 918 + }, 919 919 + string: { 920 920 + type: 'string', 921 921 + }, 922 922 + number: { 923 923 + type: 'number', 924 924 + }, 925 925 + boolean: { 926 926 + type: 'boolean', 927 927 + }, 928 928 + reference: { 929 929 + $ref: '#/components/schemas/ModelWithString', 930 930 + }, 931 931 + 'property with space': { 932 932 + type: 'string', 933 933 + }, 934 934 + default: { 935 935 + type: 'string', 936 936 + }, 937 937 + try: { 938 938 + type: 'string', 939 939 + }, 940 940 + '@namespace.string': { 941 941 + type: 'string', 942 942 + readOnly: true, 943 943 + }, 944 944 + '@namespace.integer': { 945 945 + type: 'integer', 946 946 + readOnly: true, 947 947 + }, 948 948 + }, 949 949 + } as const; 950 950 + 951 951 + export const $ModelWithNestedProperties = { 952 952 + type: 'object', 953 953 + required: ['first'], 954 954 + properties: { 955 955 + first: { 956 956 + type: 'object', 957 957 + required: ['second'], 958 958 + readOnly: true, 959 959 + nullable: true, 960 960 + properties: { 961 961 + second: { 962 962 + type: 'object', 963 963 + required: ['third'], 964 964 + readOnly: true, 965 965 + nullable: true, 966 966 + properties: { 967 967 + third: { 968 968 + type: 'string', 969 969 + required: true, 970 970 + readOnly: true, 971 971 + nullable: true, 972 972 + }, 973 973 + }, 974 974 + }, 975 975 + }, 976 976 + }, 977 977 + }, 978 978 + } as const; 979 979 + 980 980 + export const $ModelWithDuplicateProperties = { 981 981 + type: 'object', 982 982 + properties: { 983 983 + prop: { 984 984 + $ref: '#/components/schemas/ModelWithString', 985 985 + }, 986 986 + }, 987 987 + } as const; 988 988 + 989 989 + export const $ModelWithOrderedProperties = { 990 990 + type: 'object', 991 991 + properties: { 992 992 + zebra: { 993 993 + type: 'string', 994 994 + }, 995 995 + apple: { 996 996 + type: 'string', 997 997 + }, 998 998 + hawaii: { 999 999 + type: 'string', 1000 1000 + }, 1001 1001 + }, 1002 1002 + } as const; 1003 1003 + 1004 1004 + export const $ModelWithDuplicateImports = { 1005 1005 + type: 'object', 1006 1006 + properties: { 1007 1007 + propA: { 1008 1008 + $ref: '#/components/schemas/ModelWithString', 1009 1009 + }, 1010 1010 + propB: { 1011 1011 + $ref: '#/components/schemas/ModelWithString', 1012 1012 + }, 1013 1013 + propC: { 1014 1014 + $ref: '#/components/schemas/ModelWithString', 1015 1015 + }, 1016 1016 + }, 1017 1017 + } as const; 1018 1018 + 1019 1019 + export const $ModelThatExtends = { 1020 1020 + type: 'object', 1021 1021 + allOf: [ 1022 1022 + { 1023 1023 + $ref: '#/components/schemas/ModelWithString', 1024 1024 + }, 1025 1025 + { 1026 1026 + type: 'object', 1027 1027 + properties: { 1028 1028 + propExtendsA: { 1029 1029 + type: 'string', 1030 1030 + }, 1031 1031 + propExtendsB: { 1032 1032 + $ref: '#/components/schemas/ModelWithString', 1033 1033 + }, 1034 1034 + }, 1035 1035 + }, 1036 1036 + ], 1037 1037 + } as const; 1038 1038 + 1039 1039 + export const $ModelThatExtendsExtends = { 1040 1040 + type: 'object', 1041 1041 + allOf: [ 1042 1042 + { 1043 1043 + $ref: '#/components/schemas/ModelWithString', 1044 1044 + }, 1045 1045 + { 1046 1046 + $ref: '#/components/schemas/ModelThatExtends', 1047 1047 + }, 1048 1048 + { 1049 1049 + type: 'object', 1050 1050 + properties: { 1051 1051 + propExtendsC: { 1052 1052 + type: 'string', 1053 1053 + }, 1054 1054 + propExtendsD: { 1055 1055 + $ref: '#/components/schemas/ModelWithString', 1056 1056 + }, 1057 1057 + }, 1058 1058 + }, 1059 1059 + ], 1060 1060 + } as const; 1061 1061 + 1062 1062 + export const $ModelWithPattern = { 1063 1063 + type: 'object', 1064 1064 + required: ['key', 'name'], 1065 1065 + properties: { 1066 1066 + key: { 1067 1067 + maxLength: 64, 1068 1068 + pattern: '^[a-zA-Z0-9_]*$', 1069 1069 + type: 'string', 1070 1070 + }, 1071 1071 + name: { 1072 1072 + maxLength: 255, 1073 1073 + type: 'string', 1074 1074 + }, 1075 1075 + enabled: { 1076 1076 + type: 'boolean', 1077 1077 + readOnly: true, 1078 1078 + }, 1079 1079 + modified: { 1080 1080 + type: 'string', 1081 1081 + format: 'date-time', 1082 1082 + readOnly: true, 1083 1083 + }, 1084 1084 + id: { 1085 1085 + type: 'string', 1086 1086 + pattern: '^d{2}-d{3}-d{4}$', 1087 1087 + }, 1088 1088 + text: { 1089 1089 + type: 'string', 1090 1090 + pattern: '^w+$', 1091 1091 + }, 1092 1092 + patternWithSingleQuotes: { 1093 1093 + type: 'string', 1094 1094 + pattern: "^[a-zA-Z0-9']*$", 1095 1095 + }, 1096 1096 + patternWithNewline: { 1097 1097 + type: 'string', 1098 1098 + pattern: `aaa 1099 1099 + bbb`, 1100 1100 + }, 1101 1101 + patternWithBacktick: { 1102 1102 + type: 'string', 1103 1103 + pattern: 'aaa`bbb', 1104 1104 + }, 1105 1105 + }, 1106 1106 + } as const; 1107 1107 + 1108 1108 + export const $File = { 1109 1109 + required: ['mime'], 1110 1110 + type: 'object', 1111 1111 + properties: { 1112 1112 + id: { 1113 1113 + title: 'Id', 1114 1114 + type: 'string', 1115 1115 + readOnly: true, 1116 1116 + minLength: 1, 1117 1117 + }, 1118 1118 + updated_at: { 1119 1119 + title: 'Updated at', 1120 1120 + type: 'string', 1121 1121 + format: 'date-time', 1122 1122 + readOnly: true, 1123 1123 + }, 1124 1124 + created_at: { 1125 1125 + title: 'Created at', 1126 1126 + type: 'string', 1127 1127 + format: 'date-time', 1128 1128 + readOnly: true, 1129 1129 + }, 1130 1130 + mime: { 1131 1131 + title: 'Mime', 1132 1132 + type: 'string', 1133 1133 + maxLength: 24, 1134 1134 + minLength: 1, 1135 1135 + }, 1136 1136 + file: { 1137 1137 + title: 'File', 1138 1138 + type: 'string', 1139 1139 + readOnly: true, 1140 1140 + format: 'uri', 1141 1141 + }, 1142 1142 + }, 1143 1143 + } as const; 1144 1144 + 1145 1145 + export const $default = { 1146 1146 + type: 'object', 1147 1147 + properties: { 1148 1148 + name: { 1149 1149 + type: 'string', 1150 1150 + }, 1151 1151 + }, 1152 1152 + } as const; 1153 1153 + 1154 1154 + export const $Pageable = { 1155 1155 + type: 'object', 1156 1156 + properties: { 1157 1157 + page: { 1158 1158 + minimum: 0, 1159 1159 + type: 'integer', 1160 1160 + format: 'int32', 1161 1161 + default: 0, 1162 1162 + }, 1163 1163 + size: { 1164 1164 + minimum: 1, 1165 1165 + type: 'integer', 1166 1166 + format: 'int32', 1167 1167 + }, 1168 1168 + sort: { 1169 1169 + type: 'array', 1170 1170 + items: { 1171 1171 + type: 'string', 1172 1172 + }, 1173 1173 + }, 1174 1174 + }, 1175 1175 + } as const; 1176 1176 + 1177 1177 + export const $FreeFormObjectWithoutAdditionalProperties = { 1178 1178 + type: 'object', 1179 1179 + } as const; 1180 1180 + 1181 1181 + export const $FreeFormObjectWithAdditionalPropertiesEqTrue = { 1182 1182 + type: 'object', 1183 1183 + additionalProperties: true, 1184 1184 + } as const; 1185 1185 + 1186 1186 + export const $FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 1187 1187 + type: 'object', 1188 1188 + additionalProperties: {}, 1189 1189 + } as const; 1190 1190 + 1191 1191 + export const $ModelWithConst = { 1192 1192 + type: 'object', 1193 1193 + properties: { 1194 1194 + String: { 1195 1195 + const: 'String', 1196 1196 + }, 1197 1197 + number: { 1198 1198 + const: 0, 1199 1199 + }, 1200 1200 + null: { 1201 1201 + const: null, 1202 1202 + }, 1203 1203 + withType: { 1204 1204 + type: 'string', 1205 1205 + const: 'Some string', 1206 1206 + }, 1207 1207 + }, 1208 1208 + } as const; 1209 1209 + 1210 1210 + export const $ModelWithAdditionalPropertiesEqTrue = { 1211 1211 + type: 'object', 1212 1212 + properties: { 1213 1213 + prop: { 1214 1214 + type: 'string', 1215 1215 + }, 1216 1216 + }, 1217 1217 + additionalProperties: true, 1218 1218 + } as const; 1219 1219 + 1220 1220 + export const $NestedAnyOfArraysNullable = { 1221 1221 + properties: { 1222 1222 + nullableArray: { 1223 1223 + anyOf: [ 1224 1224 + { 1225 1225 + items: { 1226 1226 + anyOf: [ 1227 1227 + { 1228 1228 + type: 'string', 1229 1229 + }, 1230 1230 + { 1231 1231 + type: 'boolean', 1232 1232 + }, 1233 1233 + ], 1234 1234 + }, 1235 1235 + type: 'array', 1236 1236 + }, 1237 1237 + { 1238 1238 + type: 'null', 1239 1239 + }, 1240 1240 + ], 1241 1241 + }, 1242 1242 + }, 1243 1243 + type: 'object', 1244 1244 + } as const; 1245 1245 + 1246 1246 + export const $CompositionWithOneOfAndProperties = { 1247 1247 + type: 'object', 1248 1248 + oneOf: [ 1249 1249 + { 1250 1250 + type: 'object', 1251 1251 + required: ['foo'], 1252 1252 + properties: { 1253 1253 + foo: { 1254 1254 + $ref: '#/components/parameters/SimpleParameter', 1255 1255 + }, 1256 1256 + }, 1257 1257 + additionalProperties: false, 1258 1258 + }, 1259 1259 + { 1260 1260 + type: 'object', 1261 1261 + required: ['bar'], 1262 1262 + properties: { 1263 1263 + bar: { 1264 1264 + $ref: '#/components/schemas/NonAsciiString%C3%A6%C3%B8%C3%A5%C3%86%C3%98%C3%85%C3%B6%C3%B4%C3%AA%C3%8A%E5%AD%97%E7%AC%A6%E4%B8%B2', 1265 1265 + }, 1266 1266 + }, 1267 1267 + additionalProperties: false, 1268 1268 + }, 1269 1269 + ], 1270 1270 + required: ['baz', 'qux'], 1271 1271 + properties: { 1272 1272 + baz: { 1273 1273 + type: 'integer', 1274 1274 + format: 'uint16', 1275 1275 + minimum: 0, 1276 1276 + nullable: true, 1277 1277 + }, 1278 1278 + qux: { 1279 1279 + type: 'integer', 1280 1280 + format: 'uint8', 1281 1281 + minimum: 0, 1282 1282 + }, 1283 1283 + }, 1284 1284 + } as const; 1285 1285 + 1286 1286 + export const $NullableObject = { 1287 1287 + type: 'object', 1288 1288 + nullable: true, 1289 1289 + properties: { 1290 1290 + foo: { 1291 1291 + type: 'string', 1292 1292 + }, 1293 1293 + }, 1294 1294 + default: null, 1295 1295 + } as const; 1296 1296 + 1297 1297 + export const $CharactersInDescription = { 1298 1298 + type: 'string', 1299 1299 + } as const; 1300 1300 + 1301 1301 + export const $ModelWithNullableObject = { 1302 1302 + type: 'object', 1303 1303 + properties: { 1304 1304 + data: { 1305 1305 + $ref: '#/components/schemas/NullableObject', 1306 1306 + }, 1307 1307 + }, 1308 1308 + } as const; 1309 1309 + 1310 1310 + export const $ModelWithOneOfEnum = { 1311 1311 + oneOf: [ 1312 1312 + { 1313 1313 + type: 'object', 1314 1314 + required: ['foo'], 1315 1315 + properties: { 1316 1316 + foo: { 1317 1317 + type: 'string', 1318 1318 + enum: ['Bar'], 1319 1319 + }, 1320 1320 + }, 1321 1321 + }, 1322 1322 + { 1323 1323 + type: 'object', 1324 1324 + required: ['foo'], 1325 1325 + properties: { 1326 1326 + foo: { 1327 1327 + type: 'string', 1328 1328 + enum: ['Baz'], 1329 1329 + }, 1330 1330 + }, 1331 1331 + }, 1332 1332 + { 1333 1333 + type: 'object', 1334 1334 + required: ['foo'], 1335 1335 + properties: { 1336 1336 + foo: { 1337 1337 + type: 'string', 1338 1338 + enum: ['Qux'], 1339 1339 + }, 1340 1340 + }, 1341 1341 + }, 1342 1342 + { 1343 1343 + type: 'object', 1344 1344 + required: ['content', 'foo'], 1345 1345 + properties: { 1346 1346 + content: { 1347 1347 + type: 'string', 1348 1348 + format: 'date-time', 1349 1349 + }, 1350 1350 + foo: { 1351 1351 + type: 'string', 1352 1352 + enum: ['Quux'], 1353 1353 + }, 1354 1354 + }, 1355 1355 + }, 1356 1356 + { 1357 1357 + type: 'object', 1358 1358 + required: ['content', 'foo'], 1359 1359 + properties: { 1360 1360 + content: { 1361 1361 + type: 'array', 1362 1362 + items: [ 1363 1363 + { 1364 1364 + type: 'string', 1365 1365 + format: 'date-time', 1366 1366 + }, 1367 1367 + { 1368 1368 + type: 'string', 1369 1369 + }, 1370 1370 + ], 1371 1371 + maxItems: 2, 1372 1372 + minItems: 2, 1373 1373 + }, 1374 1374 + foo: { 1375 1375 + type: 'string', 1376 1376 + enum: ['Corge'], 1377 1377 + }, 1378 1378 + }, 1379 1379 + }, 1380 1380 + ], 1381 1381 + } as const; 1382 1382 + 1383 1383 + export const $ModelWithNestedArrayEnumsDataFoo = { 1384 1384 + enum: ['foo', 'bar'], 1385 1385 + type: 'string', 1386 1386 + } as const; 1387 1387 + 1388 1388 + export const $ModelWithNestedArrayEnumsDataBar = { 1389 1389 + enum: ['baz', 'qux'], 1390 1390 + type: 'string', 1391 1391 + } as const; 1392 1392 + 1393 1393 + export const $ModelWithNestedArrayEnumsData = { 1394 1394 + type: 'object', 1395 1395 + properties: { 1396 1396 + foo: { 1397 1397 + type: 'array', 1398 1398 + items: { 1399 1399 + $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataFoo', 1400 1400 + }, 1401 1401 + }, 1402 1402 + bar: { 1403 1403 + type: 'array', 1404 1404 + items: { 1405 1405 + $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataBar', 1406 1406 + }, 1407 1407 + }, 1408 1408 + }, 1409 1409 + } as const; 1410 1410 + 1411 1411 + export const $ModelWithNestedArrayEnums = { 1412 1412 + type: 'object', 1413 1413 + properties: { 1414 1414 + array_strings: { 1415 1415 + type: 'array', 1416 1416 + items: { 1417 1417 + type: 'string', 1418 1418 + }, 1419 1419 + }, 1420 1420 + data: { 1421 1421 + allOf: [ 1422 1422 + { 1423 1423 + $ref: '#/components/schemas/ModelWithNestedArrayEnumsData', 1424 1424 + }, 1425 1425 + ], 1426 1426 + }, 1427 1427 + }, 1428 1428 + } as const; 1429 1429 + 1430 1430 + export const $ModelWithNestedCompositionEnums = { 1431 1431 + type: 'object', 1432 1432 + properties: { 1433 1433 + foo: { 1434 1434 + allOf: [ 1435 1435 + { 1436 1436 + $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataFoo', 1437 1437 + }, 1438 1438 + ], 1439 1439 + }, 1440 1440 + }, 1441 1441 + } as const; 1442 1442 + 1443 1443 + export const $ModelWithReadOnlyAndWriteOnly = { 1444 1444 + type: 'object', 1445 1445 + required: ['foo', 'bar', 'baz'], 1446 1446 + properties: { 1447 1447 + foo: { 1448 1448 + type: 'string', 1449 1449 + }, 1450 1450 + bar: { 1451 1451 + readOnly: true, 1452 1452 + type: 'string', 1453 1453 + }, 1454 1454 + baz: { 1455 1455 + type: 'string', 1456 1456 + writeOnly: true, 1457 1457 + }, 1458 1458 + }, 1459 1459 + } as const; 1460 1460 + 1461 1461 + export const $ModelWithConstantSizeArray = { 1462 1462 + type: 'array', 1463 1463 + items: { 1464 1464 + type: 'number', 1465 1465 + }, 1466 1466 + minItems: 2, 1467 1467 + maxItems: 2, 1468 1468 + } as const; 1469 1469 + 1470 1470 + export const $ModelWithAnyOfConstantSizeArray = { 1471 1471 + type: 'array', 1472 1472 + items: { 1473 1473 + oneOf: [ 1474 1474 + { 1475 1475 + type: 'number', 1476 1476 + }, 1477 1477 + { 1478 1478 + type: 'string', 1479 1479 + }, 1480 1480 + ], 1481 1481 + }, 1482 1482 + minItems: 3, 1483 1483 + maxItems: 3, 1484 1484 + } as const; 1485 1485 + 1486 1486 + export const $ModelWithAnyOfConstantSizeArrayNullable = { 1487 1487 + type: 'array', 1488 1488 + items: { 1489 1489 + oneOf: [ 1490 1490 + { 1491 1491 + type: 'number', 1492 1492 + nullable: true, 1493 1493 + }, 1494 1494 + { 1495 1495 + type: 'string', 1496 1496 + }, 1497 1497 + ], 1498 1498 + }, 1499 1499 + minItems: 3, 1500 1500 + maxItems: 3, 1501 1501 + } as const; 1502 1502 + 1503 1503 + export const $ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = { 1504 1504 + type: 'array', 1505 1505 + items: { 1506 1506 + oneOf: [ 1507 1507 + { 1508 1508 + type: 'number', 1509 1509 + }, 1510 1510 + { 1511 1511 + type: 'string', 1512 1512 + }, 1513 1513 + ], 1514 1514 + }, 1515 1515 + minItems: 2, 1516 1516 + maxItems: 2, 1517 1517 + } as const; 1518 1518 + 1519 1519 + export const $ModelWithAnyOfConstantSizeArrayAndIntersect = { 1520 1520 + type: 'array', 1521 1521 + items: { 1522 1522 + allOf: [ 1523 1523 + { 1524 1524 + type: 'number', 1525 1525 + }, 1526 1526 + { 1527 1527 + type: 'string', 1528 1528 + }, 1529 1529 + ], 1530 1530 + }, 1531 1531 + minItems: 2, 1532 1532 + maxItems: 2, 1533 1533 + } as const; 1534 1534 + 1535 1535 + export const $ModelWithNumericEnumUnion = { 1536 1536 + type: 'object', 1537 1537 + properties: { 1538 1538 + value: { 1539 1539 + type: 'number', 1540 1540 + enum: [1, 3, 6, 12], 1541 1541 + }, 1542 1542 + }, 1543 1543 + } as const; 1544 1544 + 1545 1545 + export const $ModelWithBackticksInDescription = { 1546 1546 + type: 'object', 1547 1547 + properties: { 1548 1548 + template: { 1549 1549 + type: 'string', 1550 1550 + }, 1551 1551 + }, 1552 1552 + } as const;

+17 -1

packages/openapi-ts/test/index.spec.ts

··· 213 213 ...config, 214 214 enums: false, 215 215 exportCore: false, 216 216 - schemas: true, 216 216 + schemas: { 217 217 + type: 'json', 218 218 + }, 217 219 services: false, 218 220 types: false, 219 221 } as UserConfig, 220 222 description: 'generate JSON Schemas', 221 223 name: 'v3_schemas_json', 224 224 + }, 225 225 + { 226 226 + config: { 227 227 + ...config, 228 228 + enums: false, 229 229 + exportCore: false, 230 230 + schemas: { 231 231 + type: 'form', 232 232 + }, 233 233 + services: false, 234 234 + types: false, 235 235 + } as UserConfig, 236 236 + description: 'generate form validation schemas', 237 237 + name: 'v3_schemas_form', 222 238 }, 223 239 ])('$description', async ({ name, config }) => { 224 240 const output = toOutputPath(name);