Skip to content
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

Support readOnly and writeOnly keywords #41

Closed
ahx opened this issue Nov 26, 2019 · 2 comments
Closed

Support readOnly and writeOnly keywords #41

ahx opened this issue Nov 26, 2019 · 2 comments

Comments

@ahx
Copy link
Owner

ahx commented Nov 26, 2019 •
edited

You can use the readOnly and writeOnly keywords to mark specific properties as read-only or write-only. This is useful, for example, when GET returns more properties than used in POST – you can use the same schema in both GET and POST and mark the extra properties as readOnly. readOnly properties are included in responses but not in requests, and writeOnly properties may be sent in requests but not in responses.

Related to davishmcclurg/json_schemer#55
@ahx ahx changed the title Support OpenAPI Schemas readOnly and writeOnly keywords Support OpenAPI Schema's readOnly and writeOnly keywords Jan 21, 2020
@ahx ahx changed the title Support OpenAPI Schema's readOnly and writeOnly keywords Support JSON Schema's readOnly and writeOnly keywords Jun 17, 2020
@ahx ahx pinned this issue Jun 17, 2020
@ahx ahx changed the title Support JSON Schema's readOnly and writeOnly keywords Support readOnly and writeOnly keywords Jun 17, 2020
@ahx
Copy link
Owner Author

ahx commented Aug 31, 2020 •
edited

Seems like readOnly will have no special specificationin OAS 3.1, but it's part of JSON Schema and up to applications the define behaviour.

@ahx ahx unpinned this issue Aug 31, 2020
@ahx
Copy link
Owner Author

ahx commented Oct 15, 2020 •
edited

readOnly is done in #97, but not released, yet.

@ahx ahx closed this as completed Nov 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ahx