API & Schema Contracts¶

REST surface and JSON Schema changes that affect any programmatic client.

Across the 1.13 → 2.0 jump the REST surface gains 208 endpoints and loses 10. The JSON Schema spec gains 86 files, modifies 107, and removes 3.

Removed endpoints¶

Suggestions API removed¶

Breaking · Affects: API clients, SDKs, automation bots

SuggestionsResource is deleted. The entire /v1/suggestions namespace is gone:

Suggestions are now Tasks. See Collaboration → Suggestions for the full mapping.

Changed request contracts¶

search_after is now a repeated query parameter¶

Breaking · Affects: anyone paginating /v1/search/query

- @QueryParam("search_after") String  searchAfter    // 1.13: single comma-joined value
+ @QueryParam("search_after") List<String> searchAfter // 2.0: repeated once per sort value

Each sort value is now carried as its own parameter so values containing a comma (for example a glossary term FQN) are safe.

GET /api/v1/search/query?q=*&index=table&search_after=1712345678000,abc-123

GET /api/v1/search/query?q=*&index=table&search_after=1712345678000&search_after=abc-123

deleted query parameter on /v1/search/query deprecated¶

Deprecated · Affects: search clients

@QueryParam("deleted") on the search endpoint is annotated @Deprecated(forRemoval = true) in 2.0. Express deleted-entity filtering through query_filter instead.

testCaseStatus accepts multiple values¶

Additive, with stricter validation · Affects: data quality clients

GET /v1/dataQuality/testCases now binds testCaseStatus as a List<String>, so multiple statuses can be requested at once:

GET /api/v1/dataQuality/testCases?testCaseStatus=Failed&testCaseStatus=Aborted

Values are validated against the TestCaseStatus enum and an unknown value now returns a 400 Bad Request naming the allowed values. A single-value call is unchanged.

Changed response contracts¶

ingestionPipeline.pipelineStatuses is an array¶

— see Ingestion → pipelineStatuses.

Ingestion log stream emits structured events¶

— see Ingestion → log stream.

testCase inlines incidentStatus¶

— see Data Quality → incidentStatus.

Validation changes¶

Entity name validation tightened¶

· Affects: every write path, ingestion connectors, CSV import

type/basic.json tightens two patterns:

  "entityName": {
-   "pattern": "^((?!::).)*$"
+   "pattern": "^((?!::)[^>\"\\x00-\\x1f])*$"
  },
  "testCaseEntityName": {
-   "pattern": "^((?!::).)*$"
+   "pattern": "^((?!::)[^>\"\\x00-\\x1f])*$"
  }

In addition to the existing :: restriction, names may no longer contain:

• > (greater-than)
• " (double quote)
• any ASCII control character (\x00–\x1f)

The same restriction is applied to table column names, search-index field names, generic schema field names, and pipeline task names. Pipeline task names also gain minLength: 1, so an empty task name that previously validated is rejected in 2.0.

Auto-classification validation bounds¶

Breaking for previously out-of-range configs · Affects: database and storage auto-classification pipelines

The auto-classification schemas now require sampleDataCount >= 1 and constrain confidence to the inclusive range 0–100. Existing YAML with zero samples, a negative confidence, or a confidence above 100 no longer validates.

Enum changes¶

Removed enum values¶

Only Metadata remains. The corresponding app-config schemas were deleted:

• entity/applications/configuration/external/collateAIQualityAgentAppConfig.json
• entity/applications/configuration/external/collateAITierAgentAppConfig.json
• entity/applications/configuration/private/internal/collateAITierAgentAppPrivateConfig.json

Added enum values¶

— additive, but note that clients doing exhaustive switch/match on these enums need new branches.

Default value changes¶

Behavioural · Affects: deployments that never set these explicitly

The 2.0.0 post-data migration also lowers timerJobAcquisitionInterval to 5000 ms and the WorkflowEventConsumer poll interval from 10 s to 1 s, so governance workflows fire near-real-time instead of up to 10 s after the triggering change.

Connector filter-pattern defaults¶

· Affects: new and existing ingestion runs

Three connectors now ship non-empty default exclude patterns:

$ref relocations¶

· Affects: code generated from the spec, JSON-Schema validators

Chart function and kpiDetails definitions moved out of dataInsightCustomChart.json into a new dataInsight/custom/chartFunctions.json:

- "$ref": "dataInsightCustomChart.json#/definitions/function"
+ "$ref": "chartFunctions.json#/definitions/function"

- "$ref": "dataInsightCustomChart.json#/definitions/kpiDetails"
+ "$ref": "chartFunctions.json#/definitions/kpiDetails"

Affected files: formulaHolder.json, lineChart.json, summaryCard.json, dataInsightCustomChartResultList.json.

Similarly, entity/data/table.json extracts the inline cardinalityDistribution object into a named #/definitions/cardinalityDistribution. The wire shape is unchanged; only the pointer moved.

Notable new endpoint groups¶

— these do not break anything, but they replace patterns you may currently implement client-side.

deleteStale is available on 18 entity types: tables, databases, databaseSchemas, storedProcedures, dashboards, charts, dashboard/datamodels, pipelines, topics, mlmodels, searchIndexes, containers, apiCollections, apiEndpoints, drives/directories, drives/files, drives/spreadsheets, drives/worksheets.

Deprecations to plan for¶