docs: add known issues documentation for readOnly fields#2729
Open
1234-ad wants to merge 1 commit intoRedocly:mainfrom
Open
docs: add known issues documentation for readOnly fields#27291234-ad wants to merge 1 commit intoRedocly:mainfrom
1234-ad wants to merge 1 commit intoRedocly:mainfrom
Conversation
Addresses issue Redocly#2722 by documenting the readOnly fields problem in code examples and providing practical workarounds for users.
4 tasks
Member
|
I created a proper fix here: Redocly/openapi-sampler#183 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR addresses issue #2722 by adding documentation for the known issue with readOnly fields appearing in code examples where they shouldn't.
Changes
KNOWN_ISSUES.mdfile documenting the readOnly fields problemWhy this change?
Issue #2722 reports that readOnly fields incorrectly appear in PATCH request examples. While the core issue requires code changes to the example generation library, this documentation:
Benefits
Workarounds Provided
This is a documentation-only change that provides immediate value while the underlying issue is being investigated.