fork of hey-api/openapi-ts because I need some additional things
refactor: flatten transforms.schemas.name to transforms.schemaName
Co-authored-by: mrlubos <12529395+mrlubos@users.noreply.github.com>
+59
-119
+12
-28
docs/openapi-ts/configuration/parser.md
+12
-28
docs/openapi-ts/configuration/parser.md
···
447
447
448
448
You can customize the naming and casing pattern for `requests` and `responses` schemas using the `.name` and `.case` options.
449
449
450
-
### Schemas
450
+
### Schema Name
451
451
452
-
Sometimes your schema names are auto-generated or follow a naming convention that produces verbose or awkward type names. The `schemas` transform allows you to rename schema component keys throughout the specification, automatically updating all `$ref` pointers.
452
+
Sometimes your schema names are auto-generated or follow a naming convention that produces verbose or awkward type names. The `schemaName` transform allows you to rename schema component keys throughout the specification, automatically updating all `$ref` pointers.
453
453
454
454
This is useful for:
455
455
···
466
466
output: 'src/client',
467
467
parser: {
468
468
transforms: {
469
-
schemas: {
470
-
name: (name) => {
471
-
// Strip version markers: ServiceRoot_v1_20_0_ServiceRoot → ServiceRoot
472
-
let clean = name.replace(/([A-Za-z\d]+)_v\d+_\d+_\d+_([A-Za-z\d]*)/g, (_, p1, p2) =>
473
-
p2.startsWith(p1) ? p2 : p1 + p2,
474
-
);
475
-
// Deduplicate prefixes: Foo_Foo → Foo
476
-
const m = clean.match(/^([A-Za-z\d]+)_\1([A-Za-z\d]*)$/);
477
-
if (m) clean = m[1] + m[2];
478
-
return clean;
479
-
},
469
+
schemaName: (name) => {
470
+
// Strip version markers: ServiceRoot_v1_20_0_ServiceRoot → ServiceRoot
471
+
let clean = name.replace(/([A-Za-z\d]+)_v\d+_\d+_\d+_([A-Za-z\d]*)/g, (_, p1, p2) =>
472
+
p2.startsWith(p1) ? p2 : p1 + p2,
473
+
);
474
+
// Deduplicate prefixes: Foo_Foo → Foo
475
+
const m = clean.match(/^([A-Za-z\d]+)_\1([A-Za-z\d]*)$/);
476
+
if (m) clean = m[1] + m[2];
477
+
return clean;
480
478
},
481
479
},
482
480
},
···
489
487
output: 'src/client',
490
488
parser: {
491
489
transforms: {
492
-
schemas: {
493
-
name: 'Api{{name}}', // Add "Api" prefix to all schemas
494
-
},
495
-
},
496
-
},
497
-
};
498
-
```
499
-
500
-
```js [disabled]
501
-
export default {
502
-
input: 'hey-api/backend', // sign up at app.heyapi.dev
503
-
output: 'src/client',
504
-
parser: {
505
-
transforms: {
506
-
schemas: false, // [!code ++]
490
+
schemaName: 'Api{{name}}', // Add "Api" prefix to all schemas
507
491
},
508
492
},
509
493
};
+9
-11
packages/openapi-ts-tests/main/test/2.0.x.test.ts
+9
-11
packages/openapi-ts-tests/main/test/2.0.x.test.ts
···
293
293
output: 'transforms-schemas-name',
294
294
parser: {
295
295
transforms: {
296
-
schemas: {
297
-
name: (name: string) => {
298
-
// Strip version markers: User_v1_0_0_User → User
299
-
let clean = name.replace(/([A-Za-z\d]+)_v\d+_\d+_\d+_([A-Za-z\d]*)/g, (_, p1, p2) =>
300
-
p2.startsWith(p1) ? p2 : p1 + p2,
301
-
);
302
-
// Deduplicate prefixes: Foo_Foo → Foo
303
-
const m = clean.match(/^([A-Za-z\d]+)_\1([A-Za-z\d]*)$/);
304
-
if (m) clean = m[1] + m[2];
305
-
return clean;
306
-
},
296
+
schemaName: (name: string) => {
297
+
// Strip version markers: User_v1_0_0_User → User
298
+
let clean = name.replace(/([A-Za-z\d]+)_v\d+_\d+_\d+_([A-Za-z\d]*)/g, (_, p1, p2) =>
299
+
p2.startsWith(p1) ? p2 : p1 + p2,
300
+
);
301
+
// Deduplicate prefixes: Foo_Foo → Foo
302
+
const m = clean.match(/^([A-Za-z\d]+)_\1([A-Za-z\d]*)$/);
303
+
if (m) clean = m[1] + m[2];
304
+
return clean;
307
305
},
308
306
},
309
307
},
+9
-11
packages/openapi-ts-tests/main/test/3.0.x.test.ts
+9
-11
packages/openapi-ts-tests/main/test/3.0.x.test.ts
···
596
596
output: 'transforms-schemas-name',
597
597
parser: {
598
598
transforms: {
599
-
schemas: {
600
-
name: (name: string) => {
601
-
// Strip version markers: User_v1_0_0_User → User
602
-
let clean = name.replace(/([A-Za-z\d]+)_v\d+_\d+_\d+_([A-Za-z\d]*)/g, (_, p1, p2) =>
603
-
p2.startsWith(p1) ? p2 : p1 + p2,
604
-
);
605
-
// Deduplicate prefixes: Foo_Foo → Foo
606
-
const m = clean.match(/^([A-Za-z\d]+)_\1([A-Za-z\d]*)$/);
607
-
if (m) clean = m[1] + m[2];
608
-
return clean;
609
-
},
599
+
schemaName: (name: string) => {
600
+
// Strip version markers: User_v1_0_0_User → User
601
+
let clean = name.replace(/([A-Za-z\d]+)_v\d+_\d+_\d+_([A-Za-z\d]*)/g, (_, p1, p2) =>
602
+
p2.startsWith(p1) ? p2 : p1 + p2,
603
+
);
604
+
// Deduplicate prefixes: Foo_Foo → Foo
605
+
const m = clean.match(/^([A-Za-z\d]+)_\1([A-Za-z\d]*)$/);
606
+
if (m) clean = m[1] + m[2];
607
+
return clean;
610
608
},
611
609
},
612
610
},