Skip to content

Commit 4b375b7

Browse files
committed
type fix
1 parent 40b741f commit 4b375b7

5 files changed

Lines changed: 20 additions & 18 deletions

File tree

docs/openapi-ts/plugins/faker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ A single factory function is generated per operation for request data. It combin
9595

9696
```ts [example]
9797
// body + path + query combined into one factory
98-
export const fakeUpdatePetRequest = (options?: Options): UpdatePetData => {
98+
export const fakeUpdatePetRequest = (options?: Options): Omit<UpdatePetData, 'url'> => {
9999
const f = options?.faker ?? faker;
100100
return {
101101
body: {
@@ -112,7 +112,7 @@ export const fakeUpdatePetRequest = (options?: Options): UpdatePetData => {
112112
};
113113

114114
// body only
115-
export const fakeCreatePetRequest = (options?: Options): CreatePetData => {
115+
export const fakeCreatePetRequest = (options?: Options): Omit<CreatePetData, 'url'> => {
116116
const f = options?.faker ?? faker;
117117
return {
118118
body: {

packages/openapi-ts-tests/faker/v10/__snapshots__/2.0.x/faker-typed/@faker-js/faker.gen.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ export const fakeDocument = (options?: Options): Document => {
334334
};
335335
};
336336

337-
export const fakeListPetsRequest = (options?: Options): ListPetsData => {
337+
export const fakeListPetsRequest = (options?: Options): Omit<ListPetsData, 'url'> => {
338338
const f = options?.faker ?? faker;
339339
return { query: {
340340
...!resolveCondition(options?.includeOptional ?? true, f) ? {} : { limit: f.number.int({ min: 1, max: 100 }) }
@@ -346,7 +346,7 @@ export const fakeListPetsResponse = (options?: Options): ListPetsResponse => {
346346
return f.helpers.multiple(() => fakePet(options));
347347
};
348348

349-
export const fakeCreatePetRequest = (options?: Options): CreatePetData => {
349+
export const fakeCreatePetRequest = (options?: Options): Omit<CreatePetData, 'url'> => {
350350
const f = options?.faker ?? faker;
351351
return { body: {
352352
name: f.string.sample(),
@@ -358,7 +358,7 @@ export const fakeCreatePetResponse201 = (options?: Options): CreatePetResponses[
358358

359359
export const fakeCreatePetResponse204 = (): CreatePetResponses[204] => undefined;
360360

361-
export const fakeDeletePetRequest = (options?: Options): DeletePetData => {
361+
export const fakeDeletePetRequest = (options?: Options): Omit<DeletePetData, 'url'> => {
362362
const f = options?.faker ?? faker;
363363
return { path: {
364364
id: f.string.uuid()
@@ -369,7 +369,7 @@ export const fakeDeletePetResponse204 = (): DeletePetResponses[204] => undefined
369369

370370
export const fakeDeletePetResponse404 = (options?: Options): DeletePetErrors[404] => fakeError(options);
371371

372-
export const fakeGetPetRequest = (options?: Options): GetPetData => {
372+
export const fakeGetPetRequest = (options?: Options): Omit<GetPetData, 'url'> => {
373373
const f = options?.faker ?? faker;
374374
return { path: {
375375
id: f.string.uuid()
@@ -380,7 +380,7 @@ export const fakeGetPetResponse200 = (options?: Options): GetPetResponses[200] =
380380

381381
export const fakeGetPetResponse404 = (options?: Options): GetPetErrors[404] => fakeError(options);
382382

383-
export const fakeUpdatePetRequest = (options?: Options): UpdatePetData => {
383+
export const fakeUpdatePetRequest = (options?: Options): Omit<UpdatePetData, 'url'> => {
384384
const f = options?.faker ?? faker;
385385
return {
386386
body: {

packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-typed/@faker-js/faker.gen.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ export const fakeDocument = (options?: Options): Document => {
418418
};
419419
};
420420

421-
export const fakeListPetsRequest = (options?: Options): ListPetsData => {
421+
export const fakeListPetsRequest = (options?: Options): Omit<ListPetsData, 'url'> => {
422422
const f = options?.faker ?? faker;
423423
return { query: {
424424
...!resolveCondition(options?.includeOptional ?? true, f) ? {} : { limit: f.number.int({ min: 1, max: 100 }) }
@@ -430,7 +430,7 @@ export const fakeListPetsResponse = (options?: Options): ListPetsResponse => {
430430
return f.helpers.multiple(() => fakePet(options));
431431
};
432432

433-
export const fakeCreatePetRequest = (options?: Options): CreatePetData => {
433+
export const fakeCreatePetRequest = (options?: Options): Omit<CreatePetData, 'url'> => {
434434
const f = options?.faker ?? faker;
435435
return { body: {
436436
name: f.string.sample(),
@@ -440,7 +440,7 @@ export const fakeCreatePetRequest = (options?: Options): CreatePetData => {
440440

441441
export const fakeCreatePetResponse = (options?: Options): CreatePetResponse => fakePet(options);
442442

443-
export const fakeDeletePetRequest = (options?: Options): DeletePetData => {
443+
export const fakeDeletePetRequest = (options?: Options): Omit<DeletePetData, 'url'> => {
444444
const f = options?.faker ?? faker;
445445
return { path: {
446446
id: f.string.uuid()
@@ -449,7 +449,7 @@ export const fakeDeletePetRequest = (options?: Options): DeletePetData => {
449449

450450
export const fakeDeletePetResponse404 = (options?: Options): DeletePetErrors[404] => fakeError(options);
451451

452-
export const fakeGetPetRequest = (options?: Options): GetPetData => {
452+
export const fakeGetPetRequest = (options?: Options): Omit<GetPetData, 'url'> => {
453453
const f = options?.faker ?? faker;
454454
return { path: {
455455
id: f.string.uuid()
@@ -460,7 +460,7 @@ export const fakeGetPetResponse200 = (options?: Options): GetPetResponses[200] =
460460

461461
export const fakeGetPetResponse404 = (options?: Options): GetPetErrors[404] => fakeError(options);
462462

463-
export const fakeUpdatePetRequest = (options?: Options): UpdatePetData => {
463+
export const fakeUpdatePetRequest = (options?: Options): Omit<UpdatePetData, 'url'> => {
464464
const f = options?.faker ?? faker;
465465
return {
466466
body: {

packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-typed/@faker-js/faker.gen.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ export const fakeDocument = (options?: Options): Document => {
420420
};
421421
};
422422

423-
export const fakeListPetsRequest = (options?: Options): ListPetsData => {
423+
export const fakeListPetsRequest = (options?: Options): Omit<ListPetsData, 'url'> => {
424424
const f = options?.faker ?? faker;
425425
return { query: {
426426
...!resolveCondition(options?.includeOptional ?? true, f) ? {} : { limit: f.number.int({ min: 1, max: 100 }) }
@@ -432,7 +432,7 @@ export const fakeListPetsResponse = (options?: Options): ListPetsResponse => {
432432
return f.helpers.multiple(() => fakePet(options));
433433
};
434434

435-
export const fakeCreatePetRequest = (options?: Options): CreatePetData => {
435+
export const fakeCreatePetRequest = (options?: Options): Omit<CreatePetData, 'url'> => {
436436
const f = options?.faker ?? faker;
437437
return { body: {
438438
name: f.string.sample(),
@@ -442,7 +442,7 @@ export const fakeCreatePetRequest = (options?: Options): CreatePetData => {
442442

443443
export const fakeCreatePetResponse = (options?: Options): CreatePetResponse => fakePet(options);
444444

445-
export const fakeDeletePetRequest = (options?: Options): DeletePetData => {
445+
export const fakeDeletePetRequest = (options?: Options): Omit<DeletePetData, 'url'> => {
446446
const f = options?.faker ?? faker;
447447
return { path: {
448448
id: f.string.uuid()
@@ -451,7 +451,7 @@ export const fakeDeletePetRequest = (options?: Options): DeletePetData => {
451451

452452
export const fakeDeletePetResponse404 = (options?: Options): DeletePetErrors[404] => fakeError(options);
453453

454-
export const fakeGetPetRequest = (options?: Options): GetPetData => {
454+
export const fakeGetPetRequest = (options?: Options): Omit<GetPetData, 'url'> => {
455455
const f = options?.faker ?? faker;
456456
return { path: {
457457
id: f.string.uuid()
@@ -462,7 +462,7 @@ export const fakeGetPetResponse200 = (options?: Options): GetPetResponses[200] =
462462

463463
export const fakeGetPetResponse404 = (options?: Options): GetPetErrors[404] => fakeError(options);
464464

465-
export const fakeUpdatePetRequest = (options?: Options): UpdatePetData => {
465+
export const fakeUpdatePetRequest = (options?: Options): Omit<UpdatePetData, 'url'> => {
466466
const f = options?.faker ?? faker;
467467
return {
468468
body: {

packages/openapi-ts/src/plugins/@faker-js/faker/shared/operation-request.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,9 @@ export function irOperationRequestToAst({
155155
const arrowFn = $.func()
156156
.arrow()
157157
.$if(usesFaker, (f) => f.param('options', (p) => p.optional().type('Options')))
158-
.$if(typeSymbol, (f) => f.returns($.type(typeSymbol!)))
158+
.$if(typeSymbol, (f) =>
159+
f.returns($.type.expr('Omit').generic($.type(typeSymbol!)).generic($.type.literal('url'))),
160+
)
159161
.$if(
160162
usesAccessor,
161163
(f) => {

0 commit comments

Comments
 (0)