Skip to content

Add support for readOnly and writeOnly fields #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add support for readOnly and writeOnly fields #397

wants to merge 5 commits into from

Conversation

@elsmr
Copy link
Contributor

@elsmr elsmr commented May 19, 2021 •
edited
Loading

Handle readOnly and writeOnly fields in JSONSchema.

  • Exclude readOnly fields from Input types.
  • Exclude writeOnly fields from normal non-Input types.

https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.4

Other tools such as Redoc do something similar:

  • filter out readOnly fields in request bodies
  • filter out writeOnly fields in responses

@elsmr elsmr changed the title Exclude readOnly properties in Input types Add support for readOnly and writeOnly fields May 21, 2021
@elsmr elsmr force-pushed the readonly-props-input branch 3 times, most recently from 8fc1ccf to ea797e2 Compare May 21, 2021 13:03
elsmr added 5 commits May 21, 2021 16:55
@elsmr
Exclude readOnly properties in Input types
75014e1 
Signed-off-by: Elias Meire <elias@meire.dev>
@elsmr
Add test coverage
3b1b8e7 
Signed-off-by: Elias Meire <elias@meire.dev>
@elsmr
Use optional chaining on property schema
f02327e 
Signed-off-by: Elias Meire <elias@meire.dev>
@elsmr
Add support for writeOnly
f2a8928 
Signed-off-by: Elias Meire <elias@meire.dev>
@elsmr
Add support for writeOnly
a72a325 
Signed-off-by: Elias Meire <elias@meire.dev>
@elsmr elsmr force-pushed the readonly-props-input branch from ea797e2 to a72a325 Compare May 21, 2021 14:55
@Alan-Cha Alan-Cha mentioned this pull request Jun 7, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@elsmr