Red Hat Summit이 콘텐츠는 선택한 언어로 제공되지 않습니다.
Chapter 9. Apicurio Registry artifact and rule reference
This chapter provides details on the supported artifact types, states, metadata, and content rules that are stored in Apicurio Registry.
- Section 9.1, “Apicurio Registry artifact types”
- Section 9.2, “Apicurio Registry artifact states”
- Section 9.3, “Apicurio Registry artifact metadata”
- Section 9.4, “Apicurio Registry content rule types”
- Section 9.5, “Apicurio Registry content rule maturity”
- Section 9.6, “Apicurio Registry content rule precedence”
9.1. Apicurio Registry artifact types
You can store and manage a wide range of schema and API artifact types in Apicurio Registry.
| Type | Description |
|---|---|
|
| AsyncAPI specification |
|
| Apache Avro schema |
|
| GraphQL schema |
|
| JSON Schema |
|
| Apache Kafka Connect schema |
|
| OpenAPI specification |
|
| Google protocol buffers schema |
|
| Web Services Definition Language |
|
| Extensible Markup Language |
|
| XML Schema Definition |
9.2. Apicurio Registry artifact states
The valid artifact states in Apicurio Registry are ENABLED, DISABLED, and DEPRECATED.
| State | Description |
|---|---|
|
| Basic state, all the operations are available. |
|
| The artifact and its metadata is viewable and searchable using the Apicurio Registry web console, but its content cannot be fetched by any client. |
|
| The artifact is fully usable but a header is added to the REST API response whenever the artifact content is fetched. The Apicurio Registry Rest Client will also log a warning whenever it sees deprecated content. |
9.3. Apicurio Registry artifact metadata
When an artifact is added to Apicurio Registry, a set of metadata properties is stored along with the artifact content. This metadata consists of a set of generated read-only properties, along with some properties that you can set.
| Property | Type |
|---|---|
|
| integer |
|
| string |
|
| date |
|
| integer |
|
| string |
|
| string |
|
| string |
|
| date |
|
| array of ArtifactReference |
|
| ArtifactType |
|
| integer |
| Property | Type |
|---|---|
|
| string |
|
| array of string |
|
| string |
|
| map |
|
| ArtifactState |
Updating artifact metadata
- You can use the Apicurio Registry REST API to update the set of editable properties using the metadata endpoints.
-
You can edit the
stateproperty only by using the state transition API. For example, you can mark an artifact asdeprecatedordisabled.
9.4. Apicurio Registry content rule types
You can specify VALIDITY and COMPATIBILITY rule types to govern content evolution in Apicurio Registry.
| Type | Description |
|---|---|
|
| Validate data before adding it to the registry. The possible configuration values for this rule are:
|
|
| Ensure that newly added artifacts are compatible with previously added versions. The possible configuration values for this rule are:
|
9.5. Apicurio Registry content rule maturity
Not all content rules are fully implemented for every artifact type supported by Apicurio Registry. The following table shows the current maturity level for each rule and artifact type:
| Artifact type | Validity rule | Compatibility rule |
|---|---|---|
| Avro | Full | Full |
| Protobuf | Full | Full |
| JSON Schema | Full | Full |
| OpenAPI | Full | None |
| AsyncAPI | Syntax Only | None |
| GraphQL | Syntax Only | None |
| Kafka Connect | Syntax Only | None |
| WSDL | Full | None |
| XML | Full | None |
| XSD | Full | None |
9.6. Apicurio Registry content rule precedence
When you add or update an artifact, Apicurio Registry applies rules to check the validity and compatibility of the artifact content. Configured artifact rules override the equivalent configured global rules, as shown in the following table.
| Artifact rule | Global rule | Rule applied to this artifact | Global rule available for other artifacts? |
|---|---|---|---|
| Enabled | Enabled | Artifact | Yes |
| Disabled | Enabled | Global | Yes |
| Disabled | Disabled | None | No |
| Enabled, set to None | Enabled | None | Yes |
| Disabled | Enabled, set to None | None | No |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}