fix: Fixes #3808 Duplciate AnyOf/OneOf Description #3841
Merged
Conversation
This file contains 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
nickgros
reviewed
Aug 25, 2023
Comment on lines
+173
to
+176
| // merge top level required field | ||
| const { required } = schema; | ||
| // Merge in all the non-oneOf/anyOf properties and also skip the special ADDITIONAL_PROPERTY_FLAG property | ||
| unset(remaining, ADDITIONAL_PROPERTY_FLAG); | ||
| optionSchema = !isEmpty(remaining) ? (mergeSchemas(remaining, option) as S) : option; | ||
| optionSchema = required ? (mergeSchemas({ required }, option) as S) : option; |
There was a problem hiding this comment.
Makes sense to me, I can't think of properties other than required that should be passed through.
nickgros
requested changes
Aug 25, 2023
There was a problem hiding this comment.
@cwendtxealth can you just add to new or existing tests to ensure properties and description aren't merged, and add a line to the CHANGELOG?
cwendtxealth
commented
Aug 25, 2023
| @@ -61,6 +62,8 @@ describe('anyOf', () => { | |||
| expect(node.querySelectorAll('select')).to.have.length.of(1); | |||
| expect(node.querySelector('select').id).eql('root__anyof_select'); | |||
| expect(node.querySelectorAll('span.required')).to.have.length.of(1); | |||
| expect(node.querySelectorAll('#root__description')).to.have.length.of(1); | |||
There was a problem hiding this comment.
tested without fix these will have length of 2
cwendtxealth
commented
Aug 25, 2023
| @@ -62,6 +63,8 @@ describe('oneOf', () => { | |||
| expect(node.querySelectorAll('select')).to.have.length.of(1); | |||
| expect(node.querySelector('select').id).eql('root__oneof_select'); | |||
| expect(node.querySelectorAll('span.required')).to.have.length.of(1); | |||
| expect(node.querySelectorAll('#root__description')).to.have.length.of(1); | |||
| expect(node.querySelectorAll('#root_baz')).to.have.length.of(1); | |||
There was a problem hiding this comment.
tested without fix these will have length of 2
nickgros
approved these changes
Aug 25, 2023
Manish3323
pushed a commit
to Manish3323/react-jsonschema-form
that referenced
this pull request
Aug 31, 2023
1 task
heath-freenome
added a commit
that referenced
this pull request
Sep 8, 2023
* update antd version to v5 from v4 * update playground * Keep peer dependency of ant to v4 * update package json of playground * update changelog.md * update docs for antd * update docs for antd * Update uiSchema.md * incorporate feedback * fix: Fixes #3808 Duplciate AnyOf/OneOf Description (#3841) * Update package.json --------- Co-authored-by: Christian Wendt <54559756+cwendtxealth@users.noreply.github.com> Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>
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.
Reasons for making this change
Adding on to this fix, the description of the top level schema still shows in the oneOf/allOf fields.
Checklist
npm run test:updateto update snapshots, if needed.