Apicurio Registry artifact reference

This chapter provides details on the supported artifact types, states, metadata, and content rules that are stored in Apicurio Registry.

Apicurio Registry artifact types
Apicurio Registry artifact states
Apicurio Registry artifact metadata
Apicurio Registry content rule types
Apicurio Registry content rule maturity

Additional resources

For more detailed information, see the Apicurio Registry REST API documentation

Apicurio Registry artifact types

You can store and manage the following artifact types in Apicurio Registry:

Table 1. Apicurio Registry artifact types
Type	Description
`ASYNCAPI`	AsyncAPI specification
`AVRO`	Apache Avro schema
`GRAPHQL`	GraphQL schema
`JSON`	JSON Schema
`KCONNECT`	Apache Kafka Connect schema
`OPENAPI`	OpenAPI specification
`PROTOBUF`	Google protocol buffers schema
`PROTOBUF_FD`	Google protocol buffers file descriptor
`WSDL`	Web Services Definition Language
`XSD`	XML Schema Definition

Apicurio Registry artifact states

These are the valid artifact states in Apicurio Registry:

Table 2. Apicurio Registry artifact states
State	Description
`ENABLED`	Basic state, all the operations are available.
`DISABLED`	The artifact and its metadata is viewable and searchable using the Apicurio Registry web console, but its content cannot be fetched by any client.
`DEPRECATED`	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.

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.

Table 3. Apicurio Registry metadata properties
Property	Type	Editable
`id`	string	false
`type`	ArtifactType	false
`state`	ArtifactState	true
`version`	integer	false
`createdBy`	string	false
`createdOn`	date	false
`modifiedBy`	string	false
`modifiedOn`	date	false
`name`	string	true
`description`	string	true
`labels`	array of string	true
`properties`	map	true

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 state property only by using the state transition API. For example, you can mark an artifact as deprecated or disabled.

Additional resources

For more details, see the /artifacts/{artifactId}/meta sections in the Apicurio Registry REST API documentation.

Apicurio Registry content rule types

You can specify the following rule types to govern content evolution in Apicurio Registry:

Table 4. Apicurio Registry content rule types
Type	Description
`VALIDITY`	Validate data before adding it to the registry. The possible configuration values for this rule are: `FULL`: The validation is both syntax and semantic. `SYNTAX_ONLY`: The validation is syntax only.
`COMPATIBILITY`	Ensure that newly added artifacts are compatible with previously added versions. The possible configuration values for this rule are: `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.

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.

Table 5. Apicurio Registry content rule maturity matrix
Artifact type	Validity rule	Compatibility rule
Avro	Full	Full
Protobuf	Full	None
JSON Schema	Full	Full
OpenAPI	Full	None
AsyncAPI	Syntax Only	None
GraphQL	Syntax Only	None
Kafka Connect	Syntax Only	None
WSDL	Syntax Only	None
XSD	Syntax Only	None