红帽全球峰会此内容没有您所选择的语言版本。
Chapter 1. Apicurio Registry 3.1 release notes
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
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
Apicurio Registry 3.1 supports the following core platforms:
- Red Hat OpenShift Container Platform: 4.19, 4.18, 4.17, 4.16
- Red Hat OpenShift Service on AWS: 4.18
- Microsoft Azure Red Hat OpenShift: 4.17
- PostgreSQL: 17, 17, 16, 15, 14, 13
- Red Hat Streams for Apache Kafka: 2.9, 2.8
- OpenJDK: 17, 11
For more details, see the following article:
1.2.1. Supported integration with other products
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
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
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.
1.3.2. Apicurio Registry user documentation and examples
The open source demonstration applications are available from:
1.4. Apicurio Registry deprecated features
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
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>
<dependency>
<groupId>io.apicurio</groupId>
<artifactId>apicurio-registry-client</artifactId>
<version>3.1.0.Final-redhat-00004</version>
</dependency>1.6. Apicurio Registry known issues
The following known issues apply in Apicurio Registry 3.1:
Apicurio Registry core known issues
#5732 - Kafkasql storage does not properly handle the owner field.
Setting the owner-only-authorization property for KafkaSQL storage does not work as expected.
To workaround this issue, do not set owner-only-authorization.
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)
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.
Apicurio Registry Operator known issues
Operator-42 - Autogeneration of OpenShift route might use wrong base host value
If multiple routerCanonicalHostname values are specified, autogeneration of the Apicurio Registry OpenShift route might use a wrong base host value.
'%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}