acacode / acacode/swagger-typescript-api

Omit readonly properties from PATCH requestContent

Open
#468 4 comments 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
4.1k
Forks
436
PR merge metrics
No merged PRs in 30d

Description

If a schema is referenced as the requestContent to an API, the generated RequestBody should omit readonly properties.

Given a user:

```ts
export interface User {
readonly id: number
name: string
readonly email: string
}
```

When this type is referenced to be the input to a PATCH request, the input argument should omit readonly properties.

It should be possible to do some Typescript magic to strip readonly properties, like mentioned in https://stackoverflow.com/a/49579497/2240706.

```ts
type IfEquals =
(() => T extends X ? 1 : 2) extends
(() => T extends Y ? 1 : 2) ? A : B;

type WritableKeys = {
[P in keyof T]-?: IfEquals<{ [Q in P]: T[P] }, { -readonly [Q in P]: T[P] }, P>
}[keyof T];

type ReadonlyKeys = {
[P in keyof T]-?: IfEquals<{ [Q in P]: T[P] }, { -readonly [Q in P]: T[P] }, never, P>
}[keyof T];

type OmitReadonly = Pick>;
```

It would then be a case of updating the generated code to declare the argument as `OmitReadonly`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.