Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 10. Service Registry content rule reference
This chapter 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.
Additional resources
- For more information, see the Apicurio Registry REST API documentation.
10.1. Service Registry content rule types
You can specify VALIDITY, COMPATIBILITY, and INTEGRITY rule types to govern content evolution in Service Registry. Theses rule types apply to both global rules and artifact-specific rules.
| Type | Description |
|---|---|
|
| Validate content before adding it to Service Registry. The possible configuration values for this rule are as follows:
|
|
|
Enforce a compatibility level when updating artifacts (for example, select
|
|
| 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:
|
10.2. Service Registry content rule maturity
Not all content rules are fully implemented for every artifact type supported by Service 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 |
| OpenAPI | Full | None | Full |
| AsyncAPI | Syntax Only | None | Full |
| GraphQL | Syntax Only | None | Mapping detection not supported |
| Kafka Connect | Syntax Only | None | Mapping detection not supported |
| WSDL | Full | None | Mapping detection not supported |
| XML | Full | None | Mapping detection not supported |
| XSD | Full | None | Mapping detection not supported |
10.3. Service Registry content rule precedence
When you add or update an artifact, Service 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 |
