Breaking Changes: 1.13 → 2.0¶
Everything that changes behaviour when you move from the 1.13 line to 2.0.0 — broken out by component.
OpenMetadata 2.0 is a major release. It retires the thread-backed collaboration model, replaces the Explore experience, moves LLM/embedding configuration out of the search block, adds a database-backed session store, and reshapes several API contracts. This section documents every change that can break an existing client, script, deployment, or user workflow.
How to read this section¶
Every entry is classified so you can triage quickly:
| Badge | Meaning |
|---|---|
| Breaking | Existing callers/configs fail outright. Action is required before or during upgrade. |
| Behavioural | Requests still succeed, but the result, ordering, or side effect differs. |
| Deprecated | Still works in 2.0, scheduled for removal. Migrate at your convenience. |
| Additive | New surface only — listed where it replaces something you may be using. |
Each entry states what changed, who is affected, and what to do.
Component index¶
-
Removed endpoints, changed request/response shapes, tightened validation, enum and default changes across the JSON Schema spec.
-
The redesigned Explore page, the new browse + filter query bar, changed URL parameters, facet scoping semantics, staged ranking, and async CSV export.
-
Collaboration: Tasks, Suggestions, Announcements, Feed
The Task redesign, removal of
/v1/suggestions, standalone Announcements, the ephemeral Activity Stream, and alert-filter changes. -
Glossary/ontology, classification & tags, policies and new task operations, governance workflows, Data Access Requests and the Policy Agent.
-
Test case incident inlining, auto-close, multi-status filters, batch DQ reporting, profiler sampling, and the removed Data Insights DQ module.
-
FQN-based edge APIs, batch hydration, time-window traversal semantics, and new lineage change events.
-
pipelineStatusesshape change, Databricks Pipeline auth, Great Expectations 1.x, new connectors, progress tracking and the log-stream SSE contract. -
Search Indexing app config removals, RDF Index app defaults, Data Insights module config, MCP tool contracts, and CSV/background job changes.
-
llmConfiguration, session management and concurrent-session limits,openmetadata.yamlchanges, and the 2.0.0 database migration. -
Design-system consolidation, App Mode, persona preferences, Context Center, and removed UI components for fork/plugin maintainers.
At a glance — the ten changes most likely to break you¶
| # | Change | Component | Class |
|---|---|---|---|
| 1 | /v1/suggestions/* removed — suggestions are now Tasks | Collaboration | Breaking |
| 2 | Announcements removed from /v1/feed, now /v1/announcements | Collaboration | Breaking |
| 3 | ingestionPipeline.pipelineStatuses is now an array | Ingestion | Breaking |
| 4 | Embedding/NLQ provider config moved to top-level llmConfiguration | Platform | Breaking |
| 5 | searchIndexingAppConfig.recreateIndex / useDistributedIndexing removed | Applications | Breaking |
| 6 | Explore URL params page/size → currentPage/pageSize + new browsePath | Discovery | Breaking |
| 7 | search_after is now a repeated parameter, not a comma-joined string | API | Breaking |
| 8 | Databricks Pipeline connection requires authType instead of token | Ingestion | Breaking |
| 9 | maxActiveSessionsPerUser defaults to 5; sessions are DB-backed | Platform | Behavioural |
| 10 | entityName now rejects >, " and control characters | API | Breaking |
Upgrade checklist¶
Take a database backup before upgrading
The 2.0.0 migration renames thread_entity, creates 15+ new tables, and rewrites application, service-connection and tag rows in place. There is no automated downgrade.
Before you upgrade¶
- Inventory your API clients. Grep for
/v1/suggestions,/v1/feed,search_after=,pipelineStatuses, andrecreateIndexin scripts, dashboards, Terraform, and CI jobs. - Export your
openmetadata.yamland diff it against the 2.0 template. Theelasticsearch.naturalLanguageSearch.*provider blocks no longer exist. - Record your app configurations.
SearchIndexingApplication,DataInsightsApplication,RdfIndexAppandMcpApplicationconfigs are all rewritten by the migration. - Check entity names for
>or"characters — they will fail validation on the next write. - Note your Explore bookmarks / saved links.
?page=and?size=are no longer read.
During the upgrade¶
- Run the 2.0.0 migration with the standard
bootstraptooling. Expect these data migrations: suggestions →task_entity, thread tasks →task_entity, system feed threads →activity_stream, announcements →announcement_entity,thread_entity→thread_entity_legacy. - Allow a full search reindex. Reindexing in 2.0 always recreates the index — there is no incremental option, and the ranking configuration is backfilled into
searchSettings. - Expect the RDF Index app to switch to a weekly, full-rebuild schedule with
entities: ["all"].
After you upgrade¶
- Verify Explore results and ordering — the staged ranking algorithm changes result order.
- Re-check alert subscriptions whose filters relied on partial FQN matching.
- Re-check Snowflake / Databricks / Unity Catalog services —
policyAgentConfigdefaults were backfilled onto existing rows. - Confirm users are not being logged out unexpectedly if they routinely exceed 5 sessions.
Version scope¶
| From | OpenMetadata 1.13 line (1.13.0 – 1.13.4) |
| To | OpenMetadata 2.0.0 |
| Source | 2.0.0-release at 6861999f |
| Schema spec | 86 new schema files, 107 modified, 3 removed |
| REST surface | 208 endpoints added, 10 removed |
For an auditable file-by-file view, see the 2.0 schema change inventory or the upstream release comparison.
Collate-only features
A handful of entries reference capabilities that ship in Collate (the managed distribution) rather than OpenMetadata OSS — AI Governance Studio, the Policy Agent, Context Center, and AI Mode. They are documented here because their schemas and REST namespaces are part of the 2.0 spec and appear in the OpenAPI surface either way.