Solace Schema Registry Artifact Reference

This page lists the supported artifact types, states, and metadata that are stored in Solace Schema Registry.

Solace Schema Registry Artifact Types
Solace Schema Registry Artifact Version States
Solace Schema Registry Group Metadata
Solace Schema Registry Artifact Metadata
Solace Schema Registry Artifact Version Metadata

For more information, see the Solace Schema Registry REST API documentation.

Solace Schema Registry Artifact Types

You can store and manage a wide range of schema and API artifact types in Solace Schema Registry.

Type	Description	Supported versions
`AVRO`	Apache Avro schema	`1.0` → `1.12`
`JSON`	JSON Schema	`draft-07`

Solace Schema Registry Artifact Version States

The valid artifact version states in Solace Schema Registry are ENABLED, DISABLED, and DEPRECATED.

State	Description
`ENABLED`	This is the basic state where all operations are available.
`DISABLED`	The artifact version metadata is viewable and searchable using Solace Schema Registry web console, but its content cannot be fetched by any client.
`DEPRECATED`	The artifact version is fully usable but a header is added to the REST API response whenever the artifact version content is fetched.

Solace Schema Registry Group Metadata

When a group is created in Solace Schema 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.

System-Generated Group Properties

The following table shows system-generated properties that Solace Schema Registry automatically creates when you establish a group and uses to track its lifecycle.

Property	Type	Description
`owner`	string	The name of the user who created the group.
`createdOn`	date	The date and time when the group was created, for example, `2023-10-11T14:15:28Z`.
`modifiedBy`	string	The name of the user who modified the group.
`modifiedOn`	date	The date and time at which the group was modified, for example, `2023-10-11T14:15:28Z`.

Read-Only Group Properties

The groupId property is a read-only string that serves as the unique identifier of the artifact group in Solace Schema Registry, for example, development or production. The Solace Schema Registry automatically generates this property and you cannot modify it after group creation.

Editable Group Properties

The following table shows editable properties that you can update after group creation using Solace Schema Registry web console.

Property	Type	Description
`description`	string	Optional meaningful description of the group, for example, `This is a simple group for testing`.
`labels`	map	Optional list of user-defined name-value pairs associated with the group. The name and value must be strings, for example, `my-key` and `my-value`.

Updating Group Metadata

You can use Solace Schema Registry REST API or web console to update the set of editable metadata properties.
You can update the state property only by using Solace Schema Registry REST API.

For more details, see the /groups/{groupId} endpoint in the Solace Schema Registry REST API documentation.

Solace Schema Registry Artifact Metadata

When an artifact is added to Solace Schema 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.

System-Generated Artifact Properties

The following table shows system-generated properties that Solace Schema Registry automatically creates when you add an artifact and uses to track its lifecycle.

Property	Type	Description
`createdOn`	date	The date and time when the artifact was created, for example, `2023-10-11T14:15:28Z`.
`globalId`	integer	Globally unique identifier of an artifact version in Solace Schema Registry. For example, a global ID of `1` is assigned to the first artifact version created in Solace Schema Registry.
`modifiedBy`	string	The name of the user who modified the artifact.
`modifiedOn`	date	The date and time at which the artifact was modified, for example, `2023-10-11T14:15:28Z`.

Read-Only Artifact Properties

The following table shows read-only properties that Solace Schema Registry automatically generates and you cannot modify after artifact creation.

Property	Type	Description
`groupId`	string	Unique identifier of an artifact group in Solace Schema Registry, for example, `development` or `production`. When creating an artifact by using Solace Schema Registry web console, if you do not provide a group ID, this is set to `default`. You must provide a group ID when using Solace Schema Registry REST API or Java client.
`artifactId`	string	Unique identifier of an artifact in Solace Schema Registry. You can provide an artifact ID or use the UUID generated by Solace Schema Registry, for example, `8d168cad-1865-4e6c-bb7e-04e8be005bea`. Different versions of an artifact use the same artifact ID, but have different global IDs.
`artifactType`	ArtifactType	The supported artifact type, for example, `AVRO`, `OPENAPI`, or `PROTOBUF`.

Editable Artifact Properties

The following table shows editable properties that you can update after artifact creation using the the Solace Schema Registry web console.

Property	Type	Description
`name`	string	Optional human-readable name of the artifact, for example, `My first Avro schema`.
`description`	string	Optional meaningful description of the artifact, for example, `This is a simple OpenAPI for testing`.
`labels`	map	Optional list of user-defined name-value pairs associated with the artifact. The name and value must be strings, for example, `my-key` and `my-value`.
`owner`	string	The name of the user who owns the artifact.

Updating Artifact Metadata

You can use Solace Schema Registry REST API or web console to update the set of editable metadata properties.

For more details, see the /groups/{groupId}/artifacts/{artifactId} endpoint in the Solace Schema Registry REST API documentation.

Solace Schema Registry Artifact Version Metadata

When an artifact version is added to a Solace Schema 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.

System-Generated Artifact Version Properties

The following table shows system-generated properties that Solace Schema Registry automatically creates when you add an artifact version and uses to track its lifecycle.

Property	Type	Description
`owner`	string	The name of the user who created the artifact version.
`createdOn`	date	The date and time when the artifact version was created, for example, `2023-10-11T14:15:28Z`.
`modifiedBy`	string	The name of the user who modified the artifact version.
`modifiedOn`	date	The date and time at which the artifact version was modified, for example, `2023-10-11T14:15:28Z`.
`contentId`	integer	Unique identifier of artifact version content in Solace Schema Registry. The same content ID can be shared by multiple artifact versions when artifact versions have identical content. For example, a content ID of `4` can be used by multiple artifact versions with the same content, even across multiple artifacts.
`globalId`	integer	Globally unique identifier of an artifact version in Solace Schema Registry. For example, a global ID of `1` is assigned to the first artifact version created in Solace Schema Registry.

Read-Only Artifact Version Properties

The following table shows read-only properties that Solace Schema Registry automatically generates and you cannot modify after artifact version creation.

Property	Type	Description
`groupId`	string	Unique identifier of an artifact group in Solace Schema Registry, for example, `development` or `production`.
`artifactId`	string	Unique identifier of an artifact in Solace Schema Registry.
`version`	integer	The version string of the artifact version. If not provided, the system generates a new sequential version. You can provide a version when using Solace Schema Registry REST API or SDKs, for example, `2.1.6`.

Editable Artifact Version Properties

The following table shows editable properties that you can update after artifact version creation using Solace Schema Registry web console.

Property	Type	Description
`name`	string	Optional human-readable name of the artifact version, for example, `Version One`.
`description`	string	Optional meaningful description of the artifact version, for example, `This is the first version for testing`.
`labels`	map	Optional list of user-defined name-value pairs associated with the artifact version. The name and value must be strings, for example, `my-key` and `my-value`.
`state`	ArtifactState	The state of the artifact version: `ENABLED`, `DISABLED`, or `DEPRECATED`. Defaults to `ENABLED`.

Updating Artifact Version Metadata

You can use Solace Schema Registry REST API or web console to update the set of editable metadata properties.
You can update the state property only by using Solace Schema Registry REST API.

For more details, see the /groups/{groupId}/artifacts/{artifactId}/versions/{versionId} endpoint in the Solace Schema Registry REST API documentation.

Provide feedback