Chapter 9. Service Registry artifact reference
This chapter provides reference information on the supported artifact types, states, and metadata that are stored in Service Registry.
Additional resources
- For more information, see the Apicurio Registry REST API documentation.
9.1. Service Registry artifact types
You can store and manage a wide range of schema and API artifact types in Service 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. Service Registry artifact states
The valid artifact states in Service 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 Service 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 Service Registry Rest Client will also log a warning whenever it sees deprecated content. |
9.3. Service Registry artifact metadata
When an artifact is added to Service Registry, a set of metadata properties is created and stored along with the artifact content. This metadata consists of system-generated or user-generated properties that are read-only, and editable properties that you can update after the artifact is created.
| Property | Type | Description |
|---|---|---|
|
| integer |
Unique identifier of artifact content in Service Registry. The same content ID can be shared by multiple artifact versions when artifact versions have identical content. For example, a content ID of |
|
| string | The name of the user who created the artifact. |
|
| date |
The date and time when the artifact was created, for example, |
|
| integer |
Globally unique identifier of an artifact version in Service Registry. For example, a global ID of |
|
| string | The name of the user who modified the artifact. |
|
| date |
The date and time at which the artifact was modified, for example, |
|
| ArtifactType |
The supported artifact type, for example, |
| Property | Type | Description |
|---|---|---|
|
| string |
Unique identifier of an artifact group in Service Registry, for example, |
|
| string |
Unique identifier of an artifact in Service Registry. You can provide an artifact ID or use the UUID generated by Service Registry, for example, |
|
| array of ArtifactReference |
Optional set of artifact references contained in the artifact, which you can provide when creating the artifact. The following simple example shows a single artifact reference: |
|
| integer |
The latest version of the artifact. You can use the generated version, for example, |
| Property | Type | Description |
|---|---|---|
|
| string |
Optional meaningful description of the artifact, for example, |
|
| array of string |
Optional comma-separated list of labels used to filter and search for the artifact, for example, |
|
| string |
Optional human-readable name of the artifact, for example, |
|
| map |
Optional list of user-defined name-value pairs associated with the artifact. The name and value must be strings, for example, |
|
| ArtifactState |
The latest state of the artifact: |
Updating artifact metadata
- You can use the Service Registry REST API or web console to update the set of editable metadata properties.
-
You can update the
stateproperty only by using the Service Registry REST API.
Additional resources
For more details, see the /artifacts/{artifactId}/meta endpoint in the Apicurio Registry REST API documentation.
