Red Hat SummitChapter 11. Apicurio Registry artifact reference
This chapter provides reference information on the supported artifact types, states, and metadata that are stored in Apicurio Registry.
11.1. Apicurio Registry artifact types
You can store and manage a wide range of schema and API artifact types in Apicurio Registry.
| Type | Description | Supported versions |
|---|---|---|
|
| 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 |
11.2. Apicurio Registry artifact version states
The valid artifact version states in Apicurio Registry are ENABLED, DISABLED, and DEPRECATED.
| State | Description |
|---|---|
|
| Basic state, all the operations are available. |
|
| The artifact version metadata is viewable and searchable using the Apicurio Registry web console, but its content cannot be fetched by any client. |
|
| The artifact version is fully usable but a header is added to the REST API response whenever the artifact version content is fetched. |
11.3. Apicurio Registry group metadata
When a group is created in Apicurio Registry, a set of metadata properties is created and stored. This metadata consists of system-generated or user-generated properties that are read-only, and editable properties that you can update after the group is created.
| Property | Type | Description |
|---|---|---|
|
| string | The name of the user who created the group. |
|
| date |
The date and time when the group was created, for example, |
|
| string | The name of the user who modified the group. |
|
| date |
The date and time at which the group was modified, for example, |
| Property | Type | Description |
|---|---|---|
|
| string |
Unique identifier of the artifact group in Apicurio Registry, for example, |
| Property | Type | Description |
|---|---|---|
|
| string |
Optional meaningful description of the group, for example, |
|
| map |
Optional list of user-defined name-value pairs associated with the group. The name and value must be strings, for example, |
Updating group metadata
- You can use the Apicurio Registry REST API or web console to update the set of editable metadata properties.
-
You can update the
stateproperty only by using the Apicurio Registry REST API.
11.4. Apicurio Registry artifact metadata
When an artifact is added to Apicurio Registry, a set of metadata properties is created and stored. 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 |
|---|---|---|
|
| date |
The date and time when the artifact was created, for example, |
|
| integer |
Globally unique identifier of an artifact version in Apicurio 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, |
| Property | Type | Description |
|---|---|---|
|
| string |
Unique identifier of an artifact group in Apicurio Registry, for example, |
|
| string |
Unique identifier of an artifact in Apicurio Registry. You can provide an artifact ID or use the UUID generated by Apicurio Registry, for example, |
|
| ArtifactType |
The supported artifact type, for example, |
| Property | Type | Description |
|---|---|---|
|
| string |
Optional human-readable name of the artifact, for example, |
|
| string |
Optional meaningful description 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, |
|
| string | The name of the user who owns the artifact. |
Updating artifact metadata
- You can use the Apicurio Registry REST API or web console to update the set of editable metadata properties.
11.5. Apicurio Registry artifact version metadata
When an artifact version is added to a Apicurio Registry artifact, a set of metadata properties is created and stored along with the artifact version 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 version is created.
| Property | Type | Description |
|---|---|---|
|
| string | The name of the user who created the artifact version. |
|
| date |
The date and time when the artifact version was created, for example, |
|
| string | The user who modified the artifact version. |
|
| date |
The date and time at which the artifact version was modified, for example, |
|
| integer |
Unique identifier of artifact version content in Apicurio Registry. The same content ID can be shared by multiple artifact versions when artifact versions have identical content. For example, a content ID of |
|
| integer |
Globally unique identifier of an artifact version in Apicurio Registry. For example, a global ID of |
| Property | Type | Description |
|---|---|---|
|
| string |
Unique identifier of an artifact group in Apicurio Registry, for example, |
|
| string | Unique identifier of an artifact in Apicurio Registry. |
|
| integer |
The version string of the artifact version. If not provided, the system will generate a new sequential version. You can provide a version when using the Apicurio Registry REST API, SDKs, or Maven plug-in, for example, |
| Property | Type | Description |
|---|---|---|
|
| string |
Optional human-readable name of the artifact version, for example, |
|
| string |
Optional meaningful description of the artifact version, for example, |
|
| map |
Optional list of user-defined name-value pairs associated with the artifact version. The name and value must be strings, for example, |
|
| ArtifactState |
The state of the artifact version: |
Updating artifact version metadata
- You can use the Apicurio Registry REST API or web console to update the set of editable metadata properties.
-
You can update the
stateproperty only by using the Apicurio Registry REST API.
'%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}