Apicurio Registry artifact reference

This chapter provides reference information on the supported artifact types, states, and metadata that are stored in Apicurio Registry.

Apicurio Registry artifact types
Apicurio Registry artifact states
Apicurio Registry artifact metadata

Additional resources

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

Apicurio Registry artifact types

You can store and manage a wide range of schema and API 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
`WSDL`	Web Services Definition Language
`XML`	Extensible Markup Language
`XSD`	XML Schema Definition

Apicurio Registry artifact states

The valid artifact states in Apicurio Registry are ENABLED, DISABLED, and DEPRECATED.

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 read-only metadata
Property	Type
`contentId`	integer
`createdBy`	string
`createdOn`	date
`globalId`	integer
`groupId`	string
`id`	string
`modifiedBy`	string
`modifiedOn`	date
`references`	array of ArtifactReference
`type`	ArtifactType
`version`	integer

Table 4. Apicurio Registry editable metadata
Property	Type
`description`	string
`labels`	array of string
`name`	string
`properties`	map
`state`	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 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 endpoint in the Apicurio Registry REST API documentation.