Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Release Notes for Apicurio Registry 3.1

Red Hat build of Apicurio Registry 3.1

What's new in Red Hat build of Apicurio Registry

Red Hat build of Apicurio Registry Documentation Team

Abstract

Describes the Red Hat build of Apicurio Registry product and provides the latest details on what's new in this release.

Preface
Copy link

Providing feedback on Red Hat documentation

We appreciate your feedback on our documentation.

To propose improvements, open a Jira issue and describe your suggested changes. Provide as much detail as possible to enable us to address your request quickly.

Prerequisite

  • You have a Red Hat Customer Portal account. This account enables you to log in to the Red Hat Jira Software instance.
    If you do not have an account, you will be prompted to create one.

Procedure

  1. Click the following link: Create issue.
  2. In the Summary text box, enter a brief description of the issue.

  3. In the Description text box, provide the following information:

    • The URL of the page where you found the issue.
    • A detailed description of the issue.
      You can leave the information in any other fields at their default values.
  4. Click Create to submit the Jira issue to the documentation team.

Thank you for taking the time to provide feedback.

Chapter 1. Apicurio Registry 3.1 release notes
Copy link

Red Hat build of Apicurio Registry is a data store for standard event schemas and API designs, and is based on the Apicurio Registry open source community project.

You can use Apicurio Registry to manage and share the structure of your data using a web console, REST API, Maven plug-in, or Java client. For example, client applications can dynamically push or pull the latest schema updates to or from Apicurio Registry without needing to redeploy. You can also create optional rules to govern how Apicurio Registry content evolves over time. These rules include validation of content, integrity of artifact references, and backwards or forwards compatibility of schema or API versions.

1.1. Apicurio Registry installation options
Copy link

You can install Apicurio Registry on OpenShift with either of the following data storage options:

  • PostgreSQL database
  • Red Hat Streams for Apache Kafka

For more details, see Installing and deploying Red Hat build of Apicurio Registry on OpenShift.

1.2. Apicurio Registry supported platforms
Copy link

Apicurio Registry 3.1 supports the following core platforms:

  • Red Hat OpenShift Container Platform: 4.20, 4.19, 4.18, 4.17, 4.16
  • Red Hat OpenShift Service on AWS: 4.18
  • Microsoft Azure Red Hat OpenShift: 4.17
  • PostgreSQL: 18, 17, 16, 15, 14, 13
  • MySQL: 8.4, 8.3, 8.2, 8.1, 8.0
  • Red Hat Streams for Apache Kafka: 3.1, 3.0, 2.9, 2.8
  • OpenJDK: 17, 11

For more details, see the following article:

1.2.1. Supported integration with other products
Copy link

Apicurio Registry 3.1 also supports integration with the following products:

  • Red Hat build of Keycloak 26, 24
  • Red Hat Single Sign-On (RH-SSO) 7.6
  • Red Hat build of Debezium 2.7

1.3. Apicurio Registry new features
Copy link

The Apicurio Registry 3.1 release includes the following new features:

Custom Artifacts
This release introduces the ability to define custom artifact types at deployment/configuration time (no need to build anything). This feature allows you to expand the types of artifacts understood by Apicurio Registry. The built-in types such as Apache Avro, OpenAPI, and JSON Schema remain supported, but you can now add your own types.
Apicurio Studio
Apicurio Studio is a web-based API design suite for contract-first REST API development. Apicurio Studio enables you to visually design and collaborate on APIs separately from their implementation. In this release, Apicurio Studio functionality has been incorporated directly into the UX of Apicurio Registry. Note that Studio functionality is disabled by default. If you have used Apicurio Studio previously, see Blog Post.

1.3.1. Development Preview feature
Copy link

Important

Important Developer Preview versions are provided to expose features from upstream communities for use by early adopters and integrators to explore and interact with new capabilities in advance of their possible inclusion in a Red Hat product offering.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

MCP Server
A Model Context Protocol (MCP) server specifically designed for Apicurio Registry 3, enabling Large Language Models (LLMs) to communicate directly with your Registry instance. You can use it to explore and analyze your content by asking natural language questions, make changes in seconds, and even generate entirely new schemas with the power of AI.

The open source demonstration applications are available from:

1.4. Apicurio Registry deprecated features
Copy link

Apicurio Registry core deprecated features
  • Apicurio Registry Core API version 2: Apicurio Registry support for the original version 2 of the Apicurio Registry Core API is now deprecated. This v2 legacy API will be removed in the next major release.

You can upgrade the Apicurio Registry server automatically from Apicurio Registry 3.x to Apicurio Registry 3.1 on OpenShift. There is no automatic upgrade from Apicurio Registry 2.x to Apicurio Registry 3.x, and a migration process is required.

1.5.1. Updating 2.x client dependencies
Copy link

It is not mandatory to update client dependencies for this release. Existing Apicurio Registry 2.x client applications continue to work with Apicurio Registry 3.1.

However, you must update all of your client dependencies to use the latest version of Apicurio Registry as soon as possible. Client dependencies include dependencies for the Apicurio Registry Kafka serializers/deserializers (SerDes), Maven plug-in, and Java client applications.

For example, to update the Maven dependencies for a Java client application, specify the version in your pom.xml file as follows: 

<dependency>
    <groupId>io.apicurio</groupId>
    <artifactId>apicurio-registry-client</artifactId>
    <version>3.1.0.Final-redhat-00004</version>
</dependency>

1.6. What’s changed in Apicurio Registry 3.1.6
Copy link

The Apicurio Registry 3.1.6 release includes the following new features and resolved issues:

New features in Apicurio Registry 3.1.6

Registry Dashboard
The web console includes a new dashboard home page that provides an overview of your registry, including statistics on total groups, artifacts, and versions, a list of recently modified artifacts, and quick action links to create artifacts or explore the registry.
Schema Version Comparison Tool
The web console includes a schema version comparison tool to compare any two versions of a schema side by side. Select two versions from the Versions table and view the differences in an inline or side-by-side diff view. Use this feature to understand schema evolution and track changes across versions.
Reference Graph Visualization
The References tab in the web console includes an interactive graph view in addition to the existing table view. The graph visualization displays the dependency relationships between artifacts, including transitive references. Switch between outbound (dependencies) and inbound (dependents) views, click nodes to navigate to referenced artifacts, and use zoom, pan, and fit controls to explore the graph.
AsyncAPI 3.0 Validation
Apicurio Registry supports validation rules for AsyncAPI 3.0 schemas. Previously, validation was limited to AsyncAPI versions up to 2.6.0. With this enhancement, you can apply the same content validation rules to AsyncAPI 3.0 documents that you can apply to earlier AsyncAPI versions.
Expand
Table 1.1. Resolved issues in Apicurio Registry 3.1.6
IssueDescription

#7051

Azure Entra ID authentication fails when you enable loadUserInfo because the userinfo endpoint requires a Microsoft Graph-scoped token. API-scoped tokens that include custom app roles cannot use this token type. Set the REGISTRY_AUTH_LOAD_USER_INFO environment variable to false to disable the userinfo endpoint call for OIDC providers such as Azure Entra ID where the ID token already contains all necessary user information.

1.7. Apicurio Registry known issues
Copy link

The following known issues apply in Apicurio Registry 3.1:

Apicurio Registry core known issues

IPT-1143 - Misleading "warning" log message regarding ResultSet resource leak

You might see a message similar to the following in the logs: 

2024-07-24 08:33:53 WARN <> [io.quarkus.agroal.runtime.AgroalEventLoggingListener] (executor-thread-3) Datasource '<default>': JDBC resources leaked: 1 ResultSet(s) and 0 Statement(s)

This message is incorrect, as no JDBC resources are leaked.

You can safely ignore these messages.

IPT-814 - Apicurio Registry logout feature incompatible with RH-SSO 7.6

In RH-SSO 7.6, the redirect_uri parameter used with the logout endpoint is deprecated. For more details, see the RH-SSO 7.6 Upgrading Guide. Because of this deprecation, when Apicurio Registry is secured by using the RH-SSO Operator, clicking the Logout button displays the Invalid parameter: redirect_uri error.

For a workaround, see https://access.redhat.com/solutions/6980926.

Appendix A. Using your subscription
Copy link

Apicurio Registry is provided through a software subscription. To manage your subscriptions, access your account at the Red Hat Customer Portal.

Accessing your account

  1. Go to access.redhat.com.
  2. If you do not already have an account, create one.
  3. Log in to your account.

Activating a subscription

  1. Go to access.redhat.com.
  2. Navigate to My Subscriptions.
  3. Navigate to Activate a subscription and enter your 16-digit activation number.

Downloading ZIP and TAR files

To access ZIP or TAR files, use the customer portal to find the relevant files for download. If you are using RPM packages, this step is not required.

  1. Open a browser and log in to the Red Hat Customer Portal Product Downloads page at access.redhat.com/downloads.
  2. Locate the Red Hat Integration entries in the Integration and Automation category.
  3. Select the desired Apicurio Registry product. The Software Downloads page opens.
  4. Click the Download link for your component.

Revised on 2026-03-02 12:20:14 UTC

Legal Notice
Copy link

Copyright © Red Hat.
Except as otherwise noted below, the text of and illustrations in this documentation are licensed by Red Hat under the Creative Commons Attribution–Share Alike 3.0 Unported license . If you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, the Red Hat logo, JBoss, Hibernate, and RHCE are trademarks or registered trademarks of Red Hat, LLC. or its subsidiaries in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
XFS is a trademark or registered trademark of Hewlett Packard Enterprise Development LP or its subsidiaries in the United States and other countries.
The OpenStack® Word Mark and OpenStack logo are trademarks or registered trademarks of the Linux Foundation, used under license.
All other trademarks are the property of their respective owners.
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top