Solace Schema Registry Content Rule Reference

This section provides reference information on the supported content rule types, their level of support for artifact types, and order of precedence of artifact-specific and global rules.

For more information, see the Solace Schema Registry REST API documentation.

Solace Schema Registry Content Rule Types

You can specify VALIDITY, COMPATIBILITY, and INTEGRITY rule types to govern content evolution in Solace Schema Registry. These rule types apply to both global rules and artifact-specific rules.

Type Description

VALIDITY

Validate content before adding it to Solace Schema Registry. The possible configuration values for this rule are as follows:

  • FULL: The validation is both syntax and semantic.

  • SYNTAX_ONLY: The validation is syntax only.

  • NONE: All validation checks are disabled.

COMPATIBILITY

Enforce a compatibility level when updating artifacts (for example, select BACKWARD for backward compatibility). Ensures that new artifacts are compatible with previously added artifact versions or clients. The possible configuration values for this rule are as follows:

  • FULL: The new artifact is forward and backward compatible with the most recently added artifact.

  • FULL_TRANSITIVE: The new artifact is forward and backward compatible with all previously added artifacts.

  • BACKWARD: Clients using the new artifact can read data written using the most recently added artifact.

  • BACKWARD_TRANSITIVE: Clients using the new artifact can read data written using all previously added artifacts.

  • FORWARD: Clients using the most recently added artifact can read data written using the new artifact.

  • FORWARD_TRANSITIVE: Clients using all previously added artifacts can read data written using the new artifact.

  • NONE: All backward and forward compatibility checks are disabled.

INTEGRITY

Enforce artifact reference integrity when creating or updating artifacts. Enable and configure this rule to ensure that any artifact references provided are correct. The possible configuration values for this rule are as follows:

  • FULL: All artifact reference integrity checks are enabled.

  • NO_DUPLICATES: Detect if there are any duplicate artifact references.

  • REFS_EXIST: Detect if there are any references to non-existent artifacts.

  • ALL_REFS_MAPPED: Ensure that all artifact references are mapped.

  • NONE: All artifact reference integrity checks are disabled.

Solace Schema Registry Content Rule Maturity

Not all content rules are fully implemented for every artifact type supported by Solace Schema Registry. The following table shows the current maturity level for each rule and artifact type:

Artifact type Validity rule Compatibility rule Integrity rule

Avro

Full

Full

Full

Protobuf

Full

Full

Full

JSON Schema

Full

Full

Mapping detection not supported

XML

Full

None

Mapping detection not supported

Solace Schema Registry Content Rule Precedence

When you add or update an artifact, Solace Schema Registry applies rules to check the validity, compatibility, or integrity of the artifact content. Configured artifact-specific rules override the equivalent configured global rules, as shown in the following table.

Artifact-specific rule Global rule Rule applied to this artifact Global rule available for other artifacts?

Enabled

Enabled

Artifact-specific

Yes

Disabled

Enabled

Global

Yes

Disabled

Disabled

None

No

Enabled, set to None

Enabled

None

Yes

Disabled

Enabled, set to None

None

No