This policy is used to validate records using a provided schema.
Schema Validation
Related Documentation
OpenAPI Specifications
Incompatible with
on-prem
Tags
Example configuration
Example configurations for the Schema Validation policy.
Validate all messages for a topic
Ensure that all messages produced for a specific topic are validated against a schema:
produce_policies:
- match: "topic.name == 'xyz'"
policies:
- policy:
type: schema_validation
spec:
record_value:
schema_registry_name: my-registry
failure_action: reject
Validate all topics
Ensure that every topic is validated against a schema:
produce_policies:
- policies: # no match which means every topic requires a schema
- policy:
type: schema_validation
spec:
record_value:
schema_registry_name: my-registry
failure_action: reject
Ensure that every topic has a schema
Let’s say you want to migrate topics that don’t have schemas and eventually ensure that every topic has a schema.
For example, assume that you have three topics without schemas: topic-1, topic-2, and topic-3.
Start by setting failure_action to log, so that every time these topics are used, they’ll generate a log entry but won’t fail.
Because we don’t have policy overrides, we also need to exclude topics from the general rule.
produce_policies:
- match: "topic.name == topic-1 || topic.name == topic-2 || topic.name == topic-3"
policies:
- policy:
type: schema_validation
spec:
record_value:
schema_registry_name: my-registry
failure_action: log
- match: "topic.name != topic-1 && topic.name != topic-2 && topic.name != topic-3"
policies:
- policy:
type: schema_validation
spec:
record_value:
schema_registry_name: my-registry
failure_action: reject
Now let’s say that after some time, you migrated topic-1, and there are no logs that indicate validation failures.
You can now remove topic-1 from both expressions.