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

Record Validation Filter Documentation gaps #1415

Closed
k-wall opened this issue Aug 10, 2024 · 0 comments · Fixed by #1429
Closed

Record Validation Filter Documentation gaps #1415

k-wall opened this issue Aug 10, 2024 · 0 comments · Fixed by #1429
Labels
documentation Improvements or additions to documentation filter: record-validation triaged
Milestone

Comments

@k-wall
Copy link
Contributor

k-wall commented Aug 10, 2024

Currently the Record Validation Filter documentation is quite light. It merely illustrates how to configure the filter to apply a JSONSchema validation against a records produced to a topic.

Gaps:

  1. It doesn't discuss how the filter reacts when a validation fails. Nor does it mention how the option to forwardPartialRequests can be used to reject just the failed records or how the rules apply when transactions are in-use.
  2. It doesn't talk about the different validation types (SyntacticallyCorrectJson and SchemaValidation) and how the validations work together.
  3. It doesn't talk about allowNulls / allowEmpty.
  4. It doesn't document that SchemaValidation currently only works with JSONSchema (that is Avro etc is not supported). (Support for schema types other than JSON #1431)
  5. It doesn't document the defaultRule.
  6. It doesn't mention that Apicurio is the supported registry.
@k-wall k-wall added documentation Improvements or additions to documentation filter: record-validation labels Aug 10, 2024
k-wall added a commit to k-wall/kroxylicious that referenced this issue Aug 13, 2024
@robobario robobario added this to the 0.7.0 milestone Aug 14, 2024
@k-wall k-wall linked a pull request Aug 14, 2024 that will close this issue
7 tasks
@k-wall k-wall closed this as completed in f6a46db Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation filter: record-validation triaged
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants