このコンテンツは選択した言語では利用できません。
Chapter 1. Changes in Apicurio Registry 3.x
Apicurio Registry 3.x includes a redesigned data model, a reworked REST API, and a refreshed SDK ecosystem compared to Apicurio Registry 2.6.
Because of the breaking changes in 3.x, there is no in-place upgrade. You must deploy a new 3.x instance, migrate the persisted content, and update your client applications and automation.
When migrating to version 3.x, consider the following changes:
- Updated data model and governance
Apicurio Registry 3.x separates artifact metadata from version metadata and introduces first-class support for empty artifacts (artifacts without versions). These capabilities enable you to prepare governance metadata, rules, and branch structures before adding the first version. Additional highlights include:
- Artifact metadata is now managed independently from version metadata.
- Groups and artifacts can define custom labels to improve categorization.
-
Create and manage custom branches. The system manages the
latestbranch automatically.
- Core v3 REST API
The v3 REST API focuses on consistency and discoverability:
- Group management covers descriptions, owners, labels, and hierarchical rules.
-
New search endpoints at
/search/groupsand/search/versionsexpand discovery. -
Version-focused endpoints streamline content management and require explicit
Content-Typeheaders. -
A
dryRunquery parameter on artifact and version creation endpoints replaces the former/testendpoints. WhendryRun=true, the API validates the request and returns a response without committing changes. - A dedicated Branch API enables multitrack artifact development.
- Re-engineered Kafka storage
- The KafkaSQL storage implementation is optimized for stability and maintainability. The new design reduces startup times for large installations.
- Architectural changes in v3
- The KafkaSQL storage uses a true event journaling pattern that requires a different Kafka topic than v2, with different configuration settings. The v3 journal format is incompatible with v2.
- Separate UI container
- The user interface is now deployed as a separate container, providing more deployment flexibility and independent scaling of UI and API components.
- Generated SDKs powered by Kiota
- Apicurio Registry 3.x ships Kiota-generated SDKs that mirror the REST API structure across languages. Updated libraries are available for Java, TypeScript, Python, and Go, providing lightweight, type-safe clients with minimal dependencies and consistent naming.