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.

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

fix: #3110 by deprecating the ajv 6 validator #3211

Merged
merged 4 commits into from Oct 26, 2022

Conversation

heath-freenome
Copy link
Member

@heath-freenome heath-freenome commented Oct 26, 2022

Reasons for making this change

Fix #3110 by deprecating the @rjsf/validator-ajv6 and improving documentation

  • Updated the README.md and all files in the @rjsf/validator-ajv6 as deprecated
  • Updated the tests for all themes to switch to using the @rjsf/validator-ajv8
    • Due to the changes in messaging syntax with the ajv 8 validator the tests that displayed errors needed to be updated
  • Updated all of the documentation to be Typescript syntax, switching all examples to @rjsf/validator-ajv8 with the exception of those few examples specifically for the @rjsf/validator-ajv6
  • Updated the playground to default to the AJV8 validator and marking the AJV6 validator as deprecated
  • Updated the CHANGELOG.md accordingly

Checklist

  • I'm updating documentation
  • I'm adding or updating code
    • I've added and/or updated tests. I've run npm run test:update to update snapshots, if needed.
    • I've updated docs if needed
    • I've updated the changelog with a description of the PR
  • I'm adding a new feature
    • I've updated the playground with an example use of the feature

Fix rjsf-team#3110 by deprecating the `@rjsf/validator-ajv6` and improving documentation

- Updated the `README.md` and all files in the `@rjsf/validator-ajv6` as deprecated
- Updated the tests for all themes to switch to using the `@rjsf/validator-ajv8`
  - Due to the changes in messaging syntax with the ajv 8 validator most of the tests that displayed errors needed to be updated
- Updated all of the documentation to be Typescript syntax, switching all examples to `@rjsf/validator-ajv8` with the exception of those few examples specifically for the `@rjsf/validator-ajv6`
- Updated the playground to default to the AJV8 validator and marking the AJV6 validator as deprecated
- Updated the `CHANGELOG.md` accordingly
Copy link
Contributor

@nickgros nickgros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, see some doc suggestions

docs/5.x upgrade guide.md Outdated Show resolved Hide resolved
docs/usage/validation.md Outdated Show resolved Hide resolved
heath-freenome and others added 2 commits October 26, 2022 14:03
- Accepting reviewer feedback

Co-authored-by: Nick Grosenbacher <nickgrosenbacher@gmail.com>
- Accepting reviewer feedback

Co-authored-by: Nick Grosenbacher <nickgrosenbacher@gmail.com>
@heath-freenome heath-freenome merged commit c697688 into rjsf-team:main Oct 26, 2022
@heath-freenome heath-freenome deleted the fix-3110-deprecate-ajv6 branch October 26, 2022 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate validator-ajv6 in favor of validator-ajv8 before end of Beta
2 participants