Ce contenu n'est pas disponible dans la langue sélectionnée.

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.

9.1. Service Registry artifact types

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

Expand
Table 9.1. Service Registry artifact types
TypeDescription

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

9.2. Service Registry artifact states

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

Expand
Table 9.2. Service Registry artifact states
StateDescription

ENABLED

Basic state, all the operations are available.

DISABLED

The artifact and its metadata is viewable and searchable using the Service 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 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 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.

Expand
Table 9.3. Service Registry read-only metadata
PropertyType

contentId

integer

createdBy

string

createdOn

date

globalId

integer

groupId

string

id

string

modifiedBy

string

modifiedOn

date

references

array of ArtifactReference

type

ArtifactType

version

integer

Expand
Table 9.4. Service Registry editable metadata
PropertyType

description

string

labels

array of string

name

string

properties

map

state

ArtifactState

Updating artifact metadata

  • You can use the Service 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.
Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat