Red Hat SummitChapter 9. Apicurio Registry artifact reference
This chapter provides reference information on the supported artifact types, states, and metadata that are stored in Apicurio Registry.
Additional resources
- For more information, see the Apicurio Registry REST API documentation.
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.
Additional resources
For more details, see the /artifacts/{artifactId}/meta endpoint in the Apicurio Registry REST API documentation.
