readOnly fields are displayed in the code examples for PATCH requests
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
This issue is present when there are some readOnly fields in a PATCH request.
The readOnly fields should not be included in the PATCH request.
The documentation is correct, but the examples on the right show the readOnly fields.
Expected: those fields should not be included in the examples.
Here's a code example to reproduce this issue:
https://github.com/pushpad/pushpad-openapi/blob/master/specification/resources/subscriptions/subscriptions_update.yml
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 with the linked subscriptions_update.yml reproduction and trace how Redoc generates PATCH code examples from schemas containing readOnly fields. Check the relevant example-generation tests or entry points in this TypeScript repository. Done means readOnly properties are omitted from PATCH examples while the documentation remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100