How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Test Suites API

`TestSuite` is a set of test cases grouped together to capture data quality.

OpenMetadata Test Suites API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Test Suites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 23 operations across 17 paths, and defines 34 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

23 operations 17 paths 34 schemas 7 DELETE9 GET1 PATCH2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Test Suites API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 23

Across 17 paths, the API surfaces 23 operations — 7 DELETE, 9 GET, 1 PATCH, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Test Suites 23

TestSuite is a set of test cases grouped together to capture data quality.

GET
/v1/dataQuality/testSuites
List test suites
listTestSuites 7 params → 200
PUT
/v1/dataQuality/testSuites
Update logical test suite
createOrUpdateLogicalTestSuite body → 200
POST
/v1/dataQuality/testSuites
Create a logical test suite
createLogicalTestSuite body → 200400
PUT
/v1/dataQuality/testSuites/basic
Create or Update Basic test suite
createOrUpdateBasicTestSuite body → 200
POST
/v1/dataQuality/testSuites/basic
Create a basic test suite
createBasicTestSuite body → 200400
PUT
/v1/dataQuality/testSuites/executable
Create or Update Executable test suite
createOrUpdateExecutableTestSuite body → 200
GET
/v1/dataQuality/testSuites/name/{name}
Get a test suite by name
getTestSuiteByName 3 params → 200404
DELETE
/v1/dataQuality/testSuites/name/{name}
Delete a logical test suite
deleteLogicalTestSuite 2 params → 200404
GET
/v1/dataQuality/testSuites/{id}
Get a test suite by Id
get_5 4 params → 200404
DELETE
/v1/dataQuality/testSuites/{id}
Delete a logical test suite
deleteLogicalTestSuite_1 2 params → 200404
PATCH
/v1/dataQuality/testSuites/{id}
Update a test suite
patchTestSuite 1 param body → default
DELETE
/v1/dataQuality/testSuites/async/{id}
Delete a logical test suite asynchronously
deleteLogicalTestSuiteAsync 2 params → 200404
DELETE
/v1/dataQuality/testSuites/basic/name/{name}
Delete a test suite
deleteTestSuiteByName 3 params → 200404
DELETE
/v1/dataQuality/testSuites/basic/{id}
Delete a test suite
deleteTestSuite 3 params → 200404
DELETE
/v1/dataQuality/testSuites/executable/name/{name}
Delete a test suite
deleteTestSuiteByName_1 3 params → 200404
DELETE
/v1/dataQuality/testSuites/executable/{id}
Delete a test suite
deleteTestSuite_1 3 params → 200404
GET
/v1/dataQuality/testSuites/dataQualityReport
Get Data Quality Report
getDataQualityReport 4 params → 200
GET
/v1/dataQuality/testSuites/executionSummary
Get the execution summary of test suites
getExecutionSummaryOfTestSuites 1 param → 200
GET
/v1/dataQuality/testSuites/{id}/versions/{version}
Get a version of the test suite
getSpecificTestSuiteVersion 2 params → 200404
GET
/v1/dataQuality/testSuites/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_23 5 params → 200
GET
/v1/dataQuality/testSuites/search/list
List test suite using search service
listTestSuiteFromSearchService 15 params → 200
GET
/v1/dataQuality/testSuites/{id}/versions
List test suite versions
listAllTestSuiteVersion 1 param → 200
PUT
/v1/dataQuality/testSuites/restore
Restore a soft deleted test suite
restore_19 body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are TestSuite (44 properties), CreateTestSuite (13 properties), TagLabel (13 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
DataQualityReport
object
2 properties 2 required
TestSuiteConnection
object
1 property
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
TestSuite
object
44 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultSummary
object
3 properties
ResultList
object
5 properties 1 required
ColumnTestSummaryDefinition
object
6 properties
Paging
object
5 properties 1 required
TestConnectionResult
object
3 properties 1 required
JsonPatch
object
CreateTestSuite
object
13 properties 1 required
DataQualityReportMetadata
object
3 properties
ChangeDescription
object
5 properties
TestSummary
object
6 properties
UsageStats
object
2 properties 1 required
Style
object
3 properties
Datum
object
Votes
object
4 properties
TestSuiteList
object
5 properties 1 required
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
TestConnectionStepResult
object
5 properties 3 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-test-suites-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Test Suites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.