Chapter 8. Service Registry reference

This chapter lists the supported artifact types and content rule types that are stored in Service Registry.

Additional resources

For more detailed information on artifact and rule types, see the Apicurio Registry REST API documentation

8.1. Service Registry artifact types
Link kopieren

You can store and manage the following artifact types in Service Registry:

Expand

Table 8.1. Service Registry artifact types
Type	Description
`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
`PROTOBUF_FD`	Google protocol buffers file descriptor
`WSDL`	Web Services Definition Language
`XSD`	XML Schema Definition

You can specify the following rule types to govern content evolution in Service Registry:

Expand

Table 8.2. Service Registry content rule types
Type	Description
`VALIDITY`	Validate data before adding it to the registry. The possible configuration values for this rule are: `FULL`: The validation is both syntax and semantic. `SYNTAX_ONLY`: The validation is syntax only.
`COMPATIBILITY`	Ensure that newly added artifacts are compatible with previously added versions. The possible configuration values for this rule are: `FULL`: The new artifact is forward and backward compatible with the most recently added artifact. `FULL_TRANSITIVE`: The new artifact is forward and backward compatible with all previously added artifacts. `BACKWARD`: Clients using the new artifact can read data written using the most recently added artifact. `BACKWARD_TRANSITIVE`: Clients using the new artifact can read data written using all previously added artifacts. `FORWARD`: Clients using the most recently added artifact can read data written using the new artifact. `FORWARD_TRANSITIVE`: Clients using all previously added artifacts can read data written using the new artifact. `NONE`: All backward and forward compatibility checks are disabled.