interagent / interagent/committee
Support readOnly and writeOnly keywords
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 955
- Forks
- 145
- Avg merge
- 5d 4h
- Merged PRs (30d)
- 6
Description
Spec: http://spec.openapis.org/oas/v3.0.3#fixed-fields-19
In OpenAPI 3.1 this will be taken straight from the json-schema 2019-09 spec: readOnly and writeOnly
Supporting these keywords should be useful to describe readOnly fields.
AFAIK there is no Ruby JSON Schema validator library that supports this at the moment.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked OpenAPI 3.0.3 and JSON Schema 2019-09 specifications for readOnly and writeOnly. Then trace how Committee handles JSON Schema validation and verify that schemas using both keywords behave according to those specifications.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100