> ## Documentation Index > Fetch the complete documentation index at: https://docs.synq.io/llms.txt > Use this file to discover all available pages before exploring further. # GetSqlTestDeployOverview > Preview the effect of deploying a rule (which have not yet been saved), without deploying it. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/datachecks/sql-test-deployment-rules/v1/overview openapi: 3.1.0 info: version: '1.0' title: SYNQ servers: - url: https://developer.synq.io - url: https://api.us.synq.io - url: https://api.au.synq.io security: - bearerAuth: [] tags: - name: synq.deliveries.v1.DeliveriesService description: >- DeliveriesService reports what was sent to your notification integrations — webhooks, PagerDuty, Opsgenie — and what came back. It answers the three questions an integration owner has. "Did this event reach my endpoint": list the deliveries for an event id and read the outcome of each. "Why did my endpoint reject it": read the attempts, which carry the request as it was sent and the response as it came back. "Why did I get nothing at all": every delivery that sent nothing records a reason, so a silent integration can be explained rather than guessed at. Deliveries are kept for 90 days. Credential-bearing header values are never returned, on either side of an attempt — see `Header`. - name: synq.savedviews.v1.SavedViewsService description: >- SavedViewsService manages saved views — named, reusable selections over your entities (and other surfaces) with display configuration, sharing and per-user pinning. A saved view is owned by the user who created it. It can be kept private, shared with the whole workspace, or granted to specific users. Reads return, for the calling user, how each view relates to them (mine / shared / granted) and what they are allowed to do with it. Workspace administrators can manage any view in the workspace. - name: synq.issues.issues.v1.IssuesService description: IssuesService is a service for managing Issues. - name: synq.issues.v2.IssuesService description: IssuesService is a service for managing Issues. - name: synq.integrations.v1.IntegrationsService description: |- IntegrationsService manages connections from Coalesce Quality to your data systems (warehouses, databases, and transformation tools). Concurrency: every integration carries an opaque `etag`. Read it from `GetIntegration` / `ListIntegrations`, then pass it back on `UpdateIntegration` / `DeleteIntegration` to ensure you modify the version you last saw. A stale etag is rejected with ABORTED (HTTP 409). Omit the etag for last-write-wins. Quota: each workspace has a limit on the number of integrations. Creating beyond the limit is rejected with RESOURCE_EXHAUSTED. Secrets: credential fields (passwords, tokens, keys) are write-only. They are masked (returned empty) on every read. On update, omit a secret to keep it, send a new value to rotate it, or send an explicit empty string to clear it (where the field is `optional`). - name: synq.queries.v1.NLQueryService description: >- NLQueryService generates structured Query protos from natural language descriptions using an LLM. - name: synq.queries.v1.QueriesService description: |- QueriesService compiles and evaluates ResolverQL — the compact text query language used across Coalesce Quality to select entities — over the public API. ResolverQL is a string DSL (for example `with_type("TABLE")` or `in_folder(...)`); a structured `synq.queries.v1.Query` is its parsed, machine-readable form. This service is the bridge between the two and the read-only execution surface for both: - `TranslateResolverQl` compiles a ResolverQL expression into a structured `Query` without evaluating it — inspect it, validate it, or reuse it as a filter on another API (entity listing, folder browsing, ...). - `ResolveQuery` compiles a ResolverQL expression (or takes an already-structured `Query`), evaluates it against the catalog, and returns the matched entity ids. This is the general author -> resolve loop. - name: synq.monitors.predictions.v1.MonitorPredictionsService description: Access to anomaly detection model predictions and raw metric timeseries. - name: synq.monitors.info.v1.MonitorInfoService - name: synq.monitors.history.v1.HistoryService - name: synq.monitors.automated_monitors.v1.DeploymentRulesService - name: synq.monitors.custom_monitors.v1.CustomMonitorsService - name: synq.entities.executions.v2.EntityExecutionsService description: >- EntityExecutionsService provides read-only access to entity execution history. This service allows customers to retrieve information about all executions that happened on their entities, including execution status, timing, and messages. Use cases: - Retrieve execution history for specific entities - Filter executions by time range, status, or execution type - Get aggregated summaries of execution activity - Track execution trends and patterns - name: synq.entities.executions.v1.EntityExecutionsService description: 'Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead' - name: synq.entities.lineage.v1.LineageService description: |- LineageService allows you to fetch: * Entity level lineage from a starting point of one or more entities. * Column Level lineage from a starting point of multiple columns of a single entity. - name: synq.entities.checks.v1.ChecksCategoriesService description: |- ChecksCategoriesService lets workspace admins set explicit category overrides on individual checks. An explicit category is the authoritative category for a check — it takes precedence over the categories computed by the workspace's categorisation rules. It is a public API so customers can manage check categories programmatically; the same service is also mounted on the internal API. The workspace and the acting identity are always taken from the request context, never from the payload. - name: synq.entities.constraints.v1.TableConstraintsService description: >- TableConstraintsService provides access to table constraint and index information. - name: synq.entities.sql_insights.v1.SqlInsightsService description: >- SqlInsightsService exposes analytical information about the SQL used across a workspace's entities. It answers questions such as "which SQL constructs are used in my warehouse, and how often" and "what SQL constructs does this specific entity use", without requiring the caller to re-parse any SQL. - name: synq.entities.status.v1.EntityIncidentsService description: EntityIncidentsService is the service which retrieves entity status. - name: synq.entities.status.v1.EntityIssuesService description: EntityIssuesService is the service which retrieves entity issues status. - name: synq.entities.entities.v1.EntitiesService description: EntitiesService is a service for retriving any entity. - name: synq.entities.orchestration.v1.OrchestrationService description: >- OrchestrationService provides information about orchestration relationships between entities. This includes relationships between Airflow tasks and transformation models (dbt, SQLMesh), as well as task-to-task dependencies. - name: synq.entities.annotations.v1.AnnotationsService description: >- AnnotationsService provides operations for managing and querying entity annotations. Annotations are key-value pairs that can be attached to entities for categorization and filtering. - name: synq.entities.custom.v1.RelationshipsService description: >- RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Coalesce Quality native entity.enum There is no option to create relationships between 2 Coalesce Quality native entities (dbt model, BI dashboard, etc.). - name: synq.entities.custom.v1.EntityExecutionsService - name: synq.entities.custom.v1.FeaturesService - name: synq.entities.custom.v1.EntitiesService description: >- custom.EntitiesService is a service for managing custom entities. Entities can represent various data platform concepts such as services, consumers, applications or data pipelines that are not natively available in Coalesce Quality. Entities are identified by a unique identifier and can be created, updated, read and deleted. - name: synq.entities.custom.v1.GroupsService description: >- It eliminates the need to keep state on client side to remember which assets were already created and which should be deleted. The server will keep track of the current state of the group and client can always send the intended new state. The server will calculate the diff and entities that are no longer present in the group will be removed. Example: 1. group has entities A, B, C at time t1 2. client sends group with entities B, C, D at time t2 3. server will remove entity A from the system and update the current state of the group to B, C, D The service is designed to be idempotent and can be called multiple times with the same state without causing any side effects. - name: synq.entities.custom.v1.TypesService description: TypesService is a service for managing custom entity types. - name: synq.entities.custom.v1.ChecksRelationshipsService - name: synq.entities.folders.v1.FoldersService description: >- FoldersService discovers and browses the folder / containment hierarchy of the catalog: the roots data hangs from, the sub-folders under any folder, the folders a given entity lives in, and the entities contained in a folder. It is a read / navigation surface, not folder management — there are no create, move, or delete operations. Addressing: every folder has an opaque `folder_entity_id` (round-trip it verbatim) and a structured `FolderRef{root_entity_id, folders[]}` (the human-friendly form). Entities — both folder members and the ids you pass to `GetFolderOf` — are named by their opaque entity id, the same id used across the rest of the entities API. Depth footgun: membership is SHALLOW by default. `Browse` returns only the direct children of a folder, and `ListMembers` returns only the entities placed directly in the folder. Set `deep = true` (or raise `Browse.depth`) to recurse into sub-folders. - name: synq.entities.schemas.v1.SchemaMismatchesService description: >- SchemaMismatchesService provides access to schema drift information between data platform tables and their definitions (e.g., dbt models). - name: synq.entities.schemas.v1.SchemasService description: EntitiesService is a service for retriving any entity. - name: synq.entities.resolve.v1.IdentifierResolveService description: >- IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities. - name: synq.entities.changes.v1.ChangesService description: >- ChangesService provides functionality to track and retrieve all types of changes to data entities. This unified service returns ALL change types for an entity: - Git commits: Changes to code files (dbt models, SQL files) tracked in version control - Schema changes: Database schema modifications (columns added/removed/changed) - SQL definition changes: View/materialized view definition updates detected by Coalesce Quality Changes are returned with structured metadata including: - For git commits: structured statistics (directories, file types, top changes) - For schema changes: detailed column-level diffs - For SQL changes: before/after SQL definitions Use cases: - "What changed in the last week for table X?" → Returns git commits, schema changes, SQL changes - "Show me all commits affecting this dbt model" → Returns git commits with lineage context - "What schema changes happened to this table?" → Returns schema changes detected by Coalesce Quality - name: synq.entities.impact.v1.ImpactService - name: synq.entities.coordinates.v1.DatabaseCoordinatesService description: >- DatabaseCoordinatesService is a service for getting database coordinates of Entities. - name: synq.entities.code.v1.CodeService description: >- CodeService is a service for retrieving code associated with entities in the system. It provides functionality to access and manage code artifacts such as SQL queries, Python scripts, dbt models, and other code configurations that are part of Coalesce Quality entities. - name: synq.alerts.services.v1.AlertsService description: AlertsService provides operations for managing alert configurations. - name: synq.auth.iam.v1.IamService - name: synq.datachecks.testsuggestions.v1.TestSuggestionsService - name: synq.datachecks.v1.TriggerService description: TriggerService provides synchronous execution of datachecks on entities. - name: synq.datachecks.sqltests.v1.SqlTestsService description: SqlTestsService is a service for managing SqlTests. - name: synq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService description: |- SqlTestsDeploymentRulesService manages SqlTestDeploymentRules — rules that dynamically deploy SQL test templates onto every table or view a query matches, resyncing over time as the match set changes. - name: synq.extensions.atlan.integrations.v1.AtlanIntegrationService - name: synq.extensions.atlan.workflows.v1.AtlanWorkflowService - name: synq.extensions.atlan.provider.v1.AtlanProviderService - name: synq.schedule.v1.ScheduleService description: ScheduleService provides schedule evaluation utilities. - name: synq.git.commits.v1.CommitsService - name: synq.dataproducts.v2.DataproductsService description: |- DataproductsService manages data products — named, owned groupings of data assets with a membership definition, a priority and an optional folder. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. A data product is a leaf in the reference graph — its definition may not reference another data product or domain — so membership resolution always terminates. - name: synq.dataproducts.v1.DataproductsService description: DataproductsService can be used to manage data products. - name: synq.agent.sre.v1.TriageService description: >- Service for managing issue triage operations, allowing LLM agents to conclude investigations and record evidence during the triage process. - name: synq.agent.sre.v1.LlmService description: Service for evaluating LLM requests and producing structured output. - name: synq.agent.sre.v1.FeatureRequestService description: >- FeatureRequestService allows MCP clients to submit feature requests when users encounter missing capabilities. This is a last-resort service — it should only be used when no existing tool can fulfill the user's request. - name: synq.agent.recon.v1.SuiteDeploymentService description: |- SuiteDeploymentService is the platform plane of reconciliation. SuiteConfigService is the developer/authoring sandbox (edit, version, run ad-hoc with your own credentials — preview-only, no Entity, no Run, no Issue). A deployment is what SYNQ actually runs on the workspace's behalf: a frozen snapshot of a suite config, mapped to workspace-level SYNQ integrations, optionally scheduled or triggerable by API. Identity: every deployment has a stable deployment_id (UUIDv7) assigned on first promote. It survives re-promotes, schedule/mapping changes, and pause/resume. Downstream AssetCommand / RunCommand publication keys off deployment_id so Entity identity does not fragment on promote churn. - name: synq.agent.recon.v1.YamlService description: >- YamlService provides stateless conversion between YAML config format and proto. This is useful for UI editors that need to display/edit suite configs as YAML. - name: synq.ingest.cloudwatch.v1.CloudwatchService - name: synq.ingest.airflow.v1.AirflowLogsService - name: synq.ingest.openlineage.v1.OpenlineageService - name: synq.ingest.dwh.v1.DwhService - name: synq.owners.v1.OwnersService description: |- OwnersService manages owners and their ownerships — the "alert routing as code" surface. An owner is a named responsible party with notification channels (contacts); an ownership assigns a set of assets to an owner and configures the alerts routed to it. Owner is the resource, ownership its sub-resource: an ownership is meaningless without its owner, and deleting an owner deletes its ownerships. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on the Upsert calls: a set field is written, an omitted field is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. Related: `synq.dataproducts.v2.DataproductsService` (an ownership can own a whole data product), `synq.alerts.v1.AlertsService` (how the configured alerts are reported), and `synq.users.v1.UsersService` (resolve the users behind `UserContact` and Slack/Teams mentions). - name: synq.domains.v2.DomainsService description: >- DomainsService manages data domains — named areas of ownership that group the assets, data products and sub-domains belonging to one part of the business. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. A domain may contain other domains and data products, so membership resolution is recursive. Every write that adds such a reference — including a change of `parent_id` — is rejected if it would close a loop, so a definition can always be resolved in finite time. - name: synq.domains.members.v1.DomainMembersService description: DomainMembersService can be used to manage domain memberships. - name: synq.domains.v1.DomainsService description: DomainsService can be used to manage domains. - name: synq.platforms.v1.PlatformsService description: PlatformsService is a service for managing Platforms and Integrations. - name: synq.incidents.v1.IncidentsService description: IncidentsService is a service for managing Incidents. paths: /api/datachecks/sql-test-deployment-rules/v1/overview: get: tags: - synq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService summary: GetSqlTestDeployOverview description: >- Preview the effect of deploying a rule (which have not yet been saved), without deploying it. operationId: >- synq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService.GetSqlTestDeployOverview parameters: - name: deploymentRule.id in: query description: Unique identifier for this rule. schema: type: string title: id format: uuid description: Unique identifier for this rule. - name: deploymentRule.title in: query description: Human friendly name for this rule. schema: type: string title: title maxLength: 100 minLength: 1 description: Human friendly name for this rule. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCoreNode.integrationId in: query description: >- Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID. required: true schema: type: string title: integration_id description: >- Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCoreNode.nodeId in: query description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) required: true schema: type: string title: node_id description: >- Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.projectId in: query description: Your dbt Cloud project id required: true schema: type: string title: project_id description: Your dbt Cloud project id - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.accountId in: query description: Your dbt Cloud account id schema: type: string title: account_id description: Your dbt Cloud account id - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.nodeId in: query description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) required: true schema: type: string title: node_id description: >- Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.project in: query description: BigQuery project required: true schema: type: string title: project description: BigQuery project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.dataset in: query description: BigQuery dataset id required: true schema: type: string title: dataset description: BigQuery dataset id - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.table in: query description: BigQuery table name required: true schema: type: string title: table description: BigQuery table name - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.account in: query description: Snowflake account required: true schema: type: string title: account description: Snowflake account - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.database in: query description: Snowflake database required: true schema: type: string title: database description: Snowflake database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.schema in: query description: Snowflake schema required: true schema: type: string title: schema description: Snowflake schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.table in: query description: Snowflake table required: true schema: type: string title: table description: Snowflake table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.cluster in: query description: Redshift cluster schema: type: string title: cluster description: Redshift cluster - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.database in: query description: Redshift database required: true schema: type: string title: database description: Redshift database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.schema in: query description: Redshift schema required: true schema: type: string title: schema description: Redshift schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.table in: query description: Redshift table required: true schema: type: string title: table description: Redshift table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.host in: query description: Postgres hostname without port required: true schema: type: string title: host description: Postgres hostname without port - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.database in: query description: Postgres database required: true schema: type: string title: database description: Postgres database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.schema in: query description: Postgres schema required: true schema: type: string title: schema description: Postgres schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.table in: query description: Postgres table required: true schema: type: string title: table description: Postgres table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.host in: query description: Mysql hostname without port required: true schema: type: string title: host description: Mysql hostname without port - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.schema in: query description: Mysql database required: true schema: type: string title: schema description: Mysql database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.table in: query description: Mysql table required: true schema: type: string title: table description: Mysql table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.host in: query description: Clickhouse hostname without port required: true schema: type: string title: host description: Clickhouse hostname without port - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.schema in: query description: Clickhouse database required: true schema: type: string title: schema description: Clickhouse database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.table in: query description: Clickhouse table required: true schema: type: string title: table description: Clickhouse table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowDag.integrationId in: query description: Coalesce Quality integration_id that identifies the Airflow instance required: true schema: type: string title: integration_id description: >- Coalesce Quality integration_id that identifies the Airflow instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowDag.dagId in: query description: Airflow dag_id that identifies the DAG required: true schema: type: string title: dag_id description: Airflow dag_id that identifies the DAG - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.integrationId in: query description: Coalesce Quality integration_id that identifies the Airflow instance required: true schema: type: string title: integration_id description: >- Coalesce Quality integration_id that identifies the Airflow instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.dagId in: query description: Airflow dag_id that identifies the DAG required: true schema: type: string title: dag_id description: Airflow dag_id that identifies the DAG - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.taskId in: query description: Airflow task_id that identifies the task within the DAG required: true schema: type: string title: task_id description: Airflow task_id that identifies the task within the DAG - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.custom.id in: query description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. required: true schema: type: string title: id description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dataproduct.id in: query description: Dataproduct id that identifies the Dataproduct required: true schema: type: string title: id format: uuid description: Dataproduct id that identifies the Dataproduct - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.synqPath.path in: query description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths required: true schema: type: string title: path description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.workspace in: query description: URL of Databricks workspace required: true schema: type: string title: workspace description: URL of Databricks workspace - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.catalog in: query description: Databricks catalog required: true schema: type: string title: catalog description: Databricks catalog - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.schema in: query description: Databricks schema required: true schema: type: string title: schema description: Databricks schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.table in: query description: Databricks table or view required: true schema: type: string title: table description: Databricks table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.host in: query description: Hostname of the Trino instance required: true schema: type: string title: host description: Hostname of the Trino instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.catalog in: query description: Trino catalog required: true schema: type: string title: catalog description: Trino catalog - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.schema in: query description: Trino schema required: true schema: type: string title: schema description: Trino schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.table in: query description: Trino table or view required: true schema: type: string title: table description: Trino table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshModel.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshModel.fqn in: query description: SQLMesh model fully qualified name required: true schema: type: string title: fqn description: SQLMesh model fully qualified name - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.fqn in: query description: SQLMesh model fully qualified name required: true schema: type: string title: fqn description: SQLMesh model fully qualified name - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.auditId in: query description: Identifier of the audit required: true schema: type: string title: audit_id description: Identifier of the audit - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.host in: query description: Hostname of the SQL Server instance required: true schema: type: string title: host description: Hostname of the SQL Server instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.database in: query description: SQL Server database required: true schema: type: string title: database description: SQL Server database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.schema in: query description: SQL Server schema (e.g. "dbo") required: true schema: type: string title: schema description: SQL Server schema (e.g. "dbo") - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.table in: query description: SQL Server table or view required: true schema: type: string title: table description: SQL Server table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.host in: query description: Hostname of the Oracle instance required: true schema: type: string title: host description: Hostname of the Oracle instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.serviceName in: query description: Oracle service name (PDB) required: true schema: type: string title: service_name description: Oracle service name (PDB) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.schema in: query description: Oracle schema (= owning user) required: true schema: type: string title: schema description: Oracle schema (= owning user) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.table in: query description: Oracle table or view required: true schema: type: string title: table description: Oracle table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.instance in: query description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. required: true schema: type: string title: instance description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.catalog in: query description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. required: true schema: type: string title: catalog description: >- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.database in: query description: Glue database (the namespace users typically filter on). required: true schema: type: string title: database description: Glue database (the namespace users typically filter on). - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.table in: query description: Glue table or view name. required: true schema: type: string title: table description: Glue table or view name. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.savedView.id in: query description: Saved view id (client-supplied UUID) that identifies the saved view required: true schema: type: string title: id format: uuid description: >- Saved view id (client-supplied UUID) that identifies the saved view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.instance in: query description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". required: true schema: type: string title: instance description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.database in: query description: Fabric warehouse / lakehouse (database). required: true schema: type: string title: database description: Fabric warehouse / lakehouse (database). - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.schema in: query description: Schema within the database. required: true schema: type: string title: schema description: Schema within the database. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.table in: query description: Table or view name. required: true schema: type: string title: table description: Table or view name. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.workspaceId in: query description: |- Fabric workspace GUID, decoded from the endpoint host in `instance`. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves. schema: type: string title: workspace_id description: >- Fabric workspace GUID, decoded from the endpoint host in `instance`. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.tenantId in: query description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance`. Optional and informational, like workspace_id. schema: type: string title: tenant_id description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance`. Optional and informational, like workspace_id. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitorId in: query description: Identifier of the monitor required: true schema: type: string title: monitor_id description: Identifier of the monitor - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.segment in: query description: Optional monitor segmentation identifier schema: type: string title: segment description: Optional monitor segmentation identifier - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.integrationId in: query description: Coalesce Quality integration_id of the monitored identifier schema: type: string title: integration_id description: Coalesce Quality integration_id of the monitored identifier deprecated: true - name: deploymentRule.queryConfig.query.parts.withNameSearch.searchQuery in: query schema: type: string title: search_query - name: deploymentRule.queryConfig.query.parts.withType.type.default in: query description: Default Coalesce Quality types schema: $ref: '#/components/schemas/synq.entities.v1.EntityType' title: default description: Default Coalesce Quality types - name: deploymentRule.queryConfig.query.parts.withType.type.custom in: query description: Custom types as defined through synq.entities.custom.v1.TypesService schema: type: integer title: custom format: int32 description: >- Custom types as defined through synq.entities.custom.v1.TypesService - name: deploymentRule.queryConfig.query.parts.withAnnotation.name in: query schema: type: string title: name - name: deploymentRule.queryConfig.query.parts.withAnnotation.acceptedValue in: query schema: type: string title: accepted_value deprecated: true - name: deploymentRule.queryConfig.query.parts.withAnnotation.acceptedValues in: query schema: type: array items: type: string title: accepted_values - name: deploymentRule.queryConfig.query.parts.inFolder.path in: query description: >- Opaque folder identifiers (a folder's own entity id). `folders` is the structured, human-authorable alternative. When `path` is the only source set and `deep` is unset, `deep` defaults to true for back-compat with queries authored before `deep` existed. schema: type: array items: type: string title: path description: >- Opaque folder identifiers (a folder's own entity id). `folders` is the structured, human-authorable alternative. When `path` is the only source set and `deep` is unset, `deep` defaults to true for back-compat with queries authored before `deep` existed. - name: deploymentRule.queryConfig.query.parts.inFolder.folders.rootEntityId in: query description: >- Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from `FolderRef.root_entity_id` of a folder you already read, or from an entity id returned elsewhere. schema: type: string title: root_entity_id description: >- Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from `FolderRef.root_entity_id` of a folder you already read, or from an entity id returned elsewhere. - name: deploymentRule.queryConfig.query.parts.inFolder.folders.folders in: query description: >- Ordered folder names from the root down to this folder (root first, leaf last), for example ["staging", "sales"]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with "/") because some platforms allow "/" inside a single folder name. schema: type: array items: type: string title: folders description: >- Ordered folder names from the root down to this folder (root first, leaf last), for example ["staging", "sales"]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with "/") because some platforms allow "/" inside a single folder name. - name: deploymentRule.queryConfig.query.parts.inFolder.folderOf.entityIds in: query description: >- Simplified source: the assets named directly by opaque entity id. Use this for the common "same folder as these specific assets" case; equivalent to an input_query that lists the same ids. schema: type: array items: type: string title: entity_ids description: >- Simplified source: the assets named directly by opaque entity id. Use this for the common "same folder as these specific assets" case; equivalent to an input_query that lists the same ids. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.bigquery.project in: query description: BigQuery project required: true schema: type: string title: project description: BigQuery project - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.clickhouse.host in: query description: Clickhouse host inclusive of port required: true schema: type: string title: host description: Clickhouse host inclusive of port - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.clickhouse.schema in: query description: Clickhouse database required: true schema: type: string title: schema description: Clickhouse database - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.snowflake.account in: query description: Snowflake account required: true schema: type: string title: account description: Snowflake account - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.snowflake.database in: query description: Snowflake database required: true schema: type: string title: database description: Snowflake database - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.redshift.cluster in: query description: Redshift cluster required: true schema: type: string title: cluster description: Redshift cluster - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.redshift.database in: query description: Redshift database required: true schema: type: string title: database description: Redshift database - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.postgres.host in: query description: Postgres host inclusive of port required: true schema: type: string title: host description: Postgres host inclusive of port - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.postgres.database in: query description: Postgres database required: true schema: type: string title: database description: Postgres database - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.mysql.host in: query description: Mysql host inclusive of port required: true schema: type: string title: host description: Mysql host inclusive of port - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.databricks.workspace in: query description: URL of the databricks workspace required: true schema: type: string title: workspace description: URL of the databricks workspace - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.dbtCloud.apiEndpoint in: query description: API endpoint for Dbt Cloud required: true schema: type: string title: api_endpoint description: API endpoint for Dbt Cloud - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.dbtCloud.accountId in: query description: Account ID required: true schema: type: string title: account_id description: Account ID - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.dbtCloud.projectId in: query description: Project ID required: true schema: type: string title: project_id description: Project ID - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.sqlMesh.defaultDatabaseInstance in: query description: Default database instance for SQL Mesh required: true schema: type: string title: default_database_instance description: Default database instance for SQL Mesh - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.duckdb.motherduckAccount in: query schema: type: string title: motherduck_account - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.trino.coordinator in: query schema: type: string title: coordinator - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.mssql.host in: query description: SQL Server host required: true schema: type: string title: host description: SQL Server host - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.mssql.database in: query description: Database name required: true schema: type: string title: database description: Database name - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.oracle.host in: query description: Oracle host required: true schema: type: string title: host description: Oracle host - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.oracle.serviceName in: query description: Oracle service name (PDB) required: true schema: type: string title: service_name description: Oracle service name (PDB) - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.athena.instance in: query description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time. required: true schema: type: string title: instance description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.athena.catalog in: query description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. required: true schema: type: string title: catalog description: >- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.fabric.instance in: query description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks' workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier. required: true schema: type: string title: instance description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks' workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.fabric.workspaceId in: query description: >- Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in `instance` encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don't have to decode it yourself. `instance` remains the identifying value. Optional: empty when the host isn't a standard Fabric endpoint. schema: type: string title: workspace_id description: >- Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in `instance` encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don't have to decode it yourself. `instance` remains the identifying value. Optional: empty when the host isn't a standard Fabric endpoint. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.fabric.tenantId in: query description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance` alongside workspace_id. Optional: empty when the host isn't a standard Fabric endpoint. schema: type: string title: tenant_id description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance` alongside workspace_id. Optional: empty when the host isn't a standard Fabric endpoint. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.synqIntegrationId in: query description: >- Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform. schema: type: string title: synq_integration_id description: >- Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.withDataPlatformType.types in: query schema: type: array items: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' title: types - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inFolder.deep in: query description: >- When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too). Exception: when only the legacy `path` source is set and `deep` is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With `folders` or `folder_of`, unset means false (shallow). schema: type: boolean title: deep description: >- When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too). Exception: when only the legacy `path` source is set and `deep` is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With `folders` or `folder_of`, unset means false (shallow). - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDomain.domainId in: query schema: type: string title: domain_id format: uuid - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.identitiesOf.inputQuery.operand in: query description: Defaults to AND if not specified. schema: $ref: '#/components/schemas/synq.queries.v1.QueryOperand' title: operand description: Defaults to AND if not specified. - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.unsupported.queryJson in: query schema: type: string title: query_json - name: >- deploymentRule.queryConfig.query.parts.inFolder.folderOf.includeAllAncestors in: query description: >- When false (default): only each asset's immediate parent folder. When true: every ancestor folder up the hierarchy, so `InFolder` then also matches assets in those ancestor folders. schema: type: boolean title: include_all_ancestors description: >- When false (default): only each asset's immediate parent folder. When true: every ancestor folder up the hierarchy, so `InFolder` then also matches assets in those ancestor folders. - name: deploymentRule.queryConfig.query.parts.query.operand in: query schema: $ref: '#/components/schemas/synq.queries.v1.QueryOperand' title: operand - name: deploymentRule.queryConfig.resolverQl in: query description: >- ResolverQL selection string — an advanced, more expressive alternative to `query`. ResolverQL is a superset of the structured `query`: use it for selections `query` cannot express (e.g. lineage walks, column predicates). When set (non-empty) on write, `resolver_ql` is the source of truth and the structured `query` is ignored. On read it is echoed back VERBATIM (exactly as written, not normalized) for rules authored via ResolverQL, and is empty for rules authored via the structured `query` — so writing a read response back unchanged preserves the rule's authored form. To read the ResolverQL form of a structured rule, use `rendered_resolver_ql`. `query` is always populated regardless. schema: type: string title: resolver_ql description: >- ResolverQL selection string — an advanced, more expressive alternative to `query`. ResolverQL is a superset of the structured `query`: use it for selections `query` cannot express (e.g. lineage walks, column predicates). When set (non-empty) on write, `resolver_ql` is the source of truth and the structured `query` is ignored. On read it is echoed back VERBATIM (exactly as written, not normalized) for rules authored via ResolverQL, and is empty for rules authored via the structured `query` — so writing a read response back unchanged preserves the rule's authored form. To read the ResolverQL form of a structured rule, use `rendered_resolver_ql`. `query` is always populated regardless. - name: deploymentRule.queryConfig.renderedResolverQl in: query description: >- Canonical ResolverQL rendering of this rule's selection, populated for every rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set `resolver_ql` to author a selection in ResolverQL. schema: type: string title: rendered_resolver_ql description: >- Canonical ResolverQL rendering of this rule's selection, populated for every rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set `resolver_ql` to author a selection in ResolverQL. - name: deploymentRule.queryConfig.tests.name in: query description: >- Human friendly name for this test. Required (non-empty) for business_rule_test and business_query_test — for those two kinds, name is the test's identity key across rule redeployments, so a renamed test is treated as a different test. Optional for every other kind: leave it unset and a name is generated. schema: type: string title: name description: >- Human friendly name for this test. Required (non-empty) for business_rule_test and business_query_test — for those two kinds, name is the test's identity key across rule redeployments, so a renamed test is treated as a different test. Optional for every other kind: leave it unset and a name is generated. - name: deploymentRule.queryConfig.tests.description in: query description: >- Description of purpose and motivation, copied onto every test this rule deploys. schema: type: string title: description description: >- Description of purpose and motivation, copied onto every test this rule deploys. - name: deploymentRule.queryConfig.tests.severity in: query description: >- Overrides the rule's config-level severity for this test only. Leave unset to use the config-level severity. schema: $ref: '#/components/schemas/synq.datachecks.sqltests.v1.Severity' title: severity description: >- Overrides the rule's config-level severity for this test only. Leave unset to use the config-level severity. - name: deploymentRule.queryConfig.tests.notNullTest.columnNames in: query description: List of column names to check for NULL values schema: type: array items: type: string minItems: 1 uniqueItems: true title: column_names minItems: 1 uniqueItems: true description: List of column names to check for NULL values - name: deploymentRule.queryConfig.tests.notNullTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.emptyTest.columnNames in: query description: List of column names to check for empty values schema: type: array items: type: string minItems: 1 uniqueItems: true title: column_names minItems: 1 uniqueItems: true description: List of column names to check for empty values - name: deploymentRule.queryConfig.tests.emptyTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.acceptedValuesTest.columnName in: query description: Name of the column to validate required: true schema: type: string title: column_name description: Name of the column to validate - name: >- deploymentRule.queryConfig.tests.acceptedValuesTest.acceptedValues.stringLiteral in: query description: >- Literal value that should be quoted in SQL (e.g., '2025-05-12', 'active') schema: type: string title: string_literal description: >- Literal value that should be quoted in SQL (e.g., '2025-05-12', 'active') - name: >- deploymentRule.queryConfig.tests.acceptedValuesTest.acceptedValues.expression in: query description: >- SQL expression, numbers to be used as plain text (e.g., NOW(), COUNT(*), true, 1.1) schema: type: string title: expression description: >- SQL expression, numbers to be used as plain text (e.g., NOW(), COUNT(*), true, 1.1) - name: deploymentRule.queryConfig.tests.acceptedValuesTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.rejectedValuesTest.columnName in: query description: Name of the column to validate required: true schema: type: string title: column_name description: Name of the column to validate - name: deploymentRule.queryConfig.tests.rejectedValuesTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.uniqueTest.columnNames in: query description: List of columns that should form a unique combination schema: type: array items: type: string minItems: 1 uniqueItems: true title: column_names minItems: 1 uniqueItems: true description: List of columns that should form a unique combination - name: deploymentRule.queryConfig.tests.uniqueTest.timePartitionColumnName in: query description: >- If provided, the check will be applied to the time window of the time partition column If not provided, the check will be applied to all rows schema: type: string title: time_partition_column_name description: >- If provided, the check will be applied to the time window of the time partition column If not provided, the check will be applied to all rows - name: deploymentRule.queryConfig.tests.uniqueTest.timeWindowSeconds in: query description: Time window for uniqueness check (in seconds) schema: type: - integer - string title: time_window_seconds format: int64 description: Time window for uniqueness check (in seconds) - name: >- deploymentRule.queryConfig.tests.freshnessTest.timePartitionColumnName in: query description: Name of the timestamp column used for freshness check required: true schema: type: string title: time_partition_column_name description: Name of the timestamp column used for freshness check - name: deploymentRule.queryConfig.tests.freshnessTest.timeWindowSeconds in: query description: Time window for freshness check (in seconds) schema: type: - integer - string title: time_window_seconds format: int64 description: Time window for freshness check (in seconds) - name: deploymentRule.queryConfig.tests.freshnessTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.minMaxTest.columnName in: query description: Name of the numeric column to validate required: true schema: type: string title: column_name description: Name of the numeric column to validate - name: deploymentRule.queryConfig.tests.minMaxTest.strictly in: query description: If true, bounds are exclusive schema: type: boolean title: strictly description: If true, bounds are exclusive - name: deploymentRule.queryConfig.tests.minMaxTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.relativeTimeTest.columnName in: query description: Name of the first time column to compare required: true schema: type: string title: column_name description: Name of the first time column to compare - name: deploymentRule.queryConfig.tests.relativeTimeTest.relativeColumnName in: query description: Name of the second time column that should be later than the first required: true schema: type: string title: relative_column_name description: Name of the second time column that should be later than the first - name: deploymentRule.queryConfig.tests.relativeTimeTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.businessRuleTest.sqlExpression in: query description: |- Boolean SQL predicate evaluated per row of the anchor table (Template.identifier); rows where the predicate is TRUE are reported as failures. Format: a single boolean expression — no SELECT, WITH, or semicolons. References columns on the anchor table. The engine executes it as `SELECT * FROM WHERE `. Example: "total_amount != subtotal + tax" reports rows where totals disagree. Use BusinessQueryTest for SELECT / GROUP BY / multi-table logic. required: true schema: type: string title: sql_expression description: |- Boolean SQL predicate evaluated per row of the anchor table (Template.identifier); rows where the predicate is TRUE are reported as failures. Format: a single boolean expression — no SELECT, WITH, or semicolons. References columns on the anchor table. The engine executes it as `SELECT * FROM WHERE `. Example: "total_amount != subtotal + tax" reports rows where totals disagree. Use BusinessQueryTest for SELECT / GROUP BY / multi-table logic. - name: deploymentRule.queryConfig.tests.businessRuleTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.minValueTest.columnName in: query description: Name of the numeric column to validate required: true schema: type: string title: column_name description: Name of the numeric column to validate - name: deploymentRule.queryConfig.tests.minValueTest.strictly in: query description: If true, the minimum value is exclusive schema: type: boolean title: strictly description: If true, the minimum value is exclusive - name: deploymentRule.queryConfig.tests.minValueTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.maxValueTest.columnName in: query description: Name of the numeric column to validate required: true schema: type: string title: column_name description: Name of the numeric column to validate - name: deploymentRule.queryConfig.tests.maxValueTest.strictly in: query description: If true, the maximum value is exclusive schema: type: boolean title: strictly description: If true, the maximum value is exclusive - name: deploymentRule.queryConfig.tests.maxValueTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: >- deploymentRule.queryConfig.tests.relationshipsTest.references.columns.source in: query description: Column name in the source table required: true schema: type: string title: source description: Column name in the source table - name: >- deploymentRule.queryConfig.tests.relationshipsTest.references.columns.reference in: query description: Column name in the reference table required: true schema: type: string title: reference description: Column name in the reference table - name: deploymentRule.queryConfig.tests.relationshipsTest.ignoreNulls in: query description: >- If true, source rows where all join columns are NULL are excluded from results schema: type: boolean title: ignore_nulls description: >- If true, source rows where all join columns are NULL are excluded from results - name: >- deploymentRule.queryConfig.tests.relationshipsTest.timePartitionColumn in: query description: Column name used to filter source rows by time (e.g., "created_at") schema: type: string title: time_partition_column description: >- Column name used to filter source rows by time (e.g., "created_at") - name: deploymentRule.queryConfig.tests.relationshipsTest.timeWindowSeconds in: query description: Time window in seconds - only check source rows within this window schema: type: - integer - string title: time_window_seconds format: int64 description: Time window in seconds - only check source rows within this window - name: deploymentRule.queryConfig.tests.relationshipsTest.selectColumns in: query description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. schema: type: array items: type: string uniqueItems: true title: select_columns uniqueItems: true description: >- Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. - name: deploymentRule.queryConfig.tests.businessQueryTest.sqlQuery in: query description: |- Full SELECT statement. Result rows are reported as failures. Format: a single SELECT (CTEs allowed); no semicolon. May read any tables the integration has access to. The engine wraps it as `WITH raw_query AS () SELECT * FROM raw_query`. Use this when the failure set requires GROUP BY, JOINs, window functions, or other shape that a per-row predicate (BusinessRuleTest) cannot express. Example: SELECT customer_id, SUM(amount) AS total FROM orders WHERE status = 'paid' GROUP BY customer_id HAVING SUM(amount) < 0 Template.identifier still anchors the test to a primary table for ownership, alerts, and UI grouping. Note: this test does not expose a `select_columns` option. The author controls the SELECT shape directly in `sql_query`. required: true schema: type: string title: sql_query description: |- Full SELECT statement. Result rows are reported as failures. Format: a single SELECT (CTEs allowed); no semicolon. May read any tables the integration has access to. The engine wraps it as `WITH raw_query AS () SELECT * FROM raw_query`. Use this when the failure set requires GROUP BY, JOINs, window functions, or other shape that a per-row predicate (BusinessRuleTest) cannot express. Example: SELECT customer_id, SUM(amount) AS total FROM orders WHERE status = 'paid' GROUP BY customer_id HAVING SUM(amount) < 0 Template.identifier still anchors the test to a primary table for ownership, alerts, and UI grouping. Note: this test does not expose a `select_columns` option. The author controls the SELECT shape directly in `sql_query`. - name: deploymentRule.queryConfig.recurrenceRule in: query description: >- [Recurrence rule](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) for the execution schedule applied to every test this rule deploys. Empty means on-demand — deployed tests are never scheduled to run automatically. schema: type: string title: recurrence_rule description: >- [Recurrence rule](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) for the execution schedule applied to every test this rule deploys. Empty means on-demand — deployed tests are never scheduled to run automatically. - name: deploymentRule.queryConfig.timezone in: query description: >- IANA timezone name (e.g., "Europe/Prague", "America/New_York") used to interpret recurrence_rule. Empty defaults to UTC. schema: type: string title: timezone description: >- IANA timezone name (e.g., "Europe/Prague", "America/New_York") used to interpret recurrence_rule. Empty defaults to UTC. - name: deploymentRule.queryConfig.severity in: query description: |- Severity applied to every test this rule deploys, unless a RuleTest overrides it. Required — must be set to a value other than unspecified. schema: $ref: '#/components/schemas/synq.datachecks.sqltests.v1.Severity' not: enum: - 0 title: severity description: >- Severity applied to every test this rule deploys, unless a RuleTest overrides it. Required — must be set to a value other than unspecified. - name: deploymentRule.queryConfig.saveFailures in: query description: >- Applied to every test this rule deploys. Toggles saving of failure runs. schema: type: boolean title: save_failures description: >- Applied to every test this rule deploys. Toggles saving of failure runs. - name: deploymentRule.queryConfig.keepRemovedTests in: query description: |- When a previously matched table or view stops matching this rule's selection, its deployed tests are deleted by default. Set true to keep them as-is instead — they remain rule-managed but are no longer resynced. schema: type: boolean title: keep_removed_tests description: |- When a previously matched table or view stops matching this rule's selection, its deployed tests are deleted by default. Set true to keep them as-is instead — they remain rule-managed but are no longer resynced. - name: deploymentRule.exclusiveQueryConfig.resolverQl in: query description: |- ResolverQL selection string for the exclusion set. Same semantics as SqlTestsQueryConfig.resolver_ql: when set on write it takes precedence over `query`; on read it is echoed back VERBATIM for ResolverQL-authored rules and is empty for structured-`query` rules (whose ResolverQL form is in `rendered_resolver_ql`). `query` is always populated. schema: type: string title: resolver_ql description: >- ResolverQL selection string for the exclusion set. Same semantics as SqlTestsQueryConfig.resolver_ql: when set on write it takes precedence over `query`; on read it is echoed back VERBATIM for ResolverQL-authored rules and is empty for structured-`query` rules (whose ResolverQL form is in `rendered_resolver_ql`). `query` is always populated. - name: deploymentRule.exclusiveQueryConfig.renderedResolverQl in: query description: >- Canonical ResolverQL rendering of the exclusion selection. OUTPUT ONLY, populated for every rule, ignored on write. schema: type: string title: rendered_resolver_ql description: >- Canonical ResolverQL rendering of the exclusion selection. OUTPUT ONLY, populated for every rule, ignored on write. - name: deploymentRule.staticConfig.path in: query description: Synq path of the table or view this rule deploys tests onto. schema: type: string title: path description: Synq path of the table or view this rule deploys tests onto. - name: deploymentRule.staticConfig.recurrenceRule in: query description: >- [Recurrence rule](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) for the execution schedule applied to every test this rule deploys. Empty means on-demand. schema: type: string title: recurrence_rule description: >- [Recurrence rule](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) for the execution schedule applied to every test this rule deploys. Empty means on-demand. - name: deploymentRule.staticConfig.timezone in: query description: >- IANA timezone name used to interpret recurrence_rule. Empty defaults to UTC. schema: type: string title: timezone description: >- IANA timezone name used to interpret recurrence_rule. Empty defaults to UTC. - name: deploymentRule.staticConfig.severity in: query description: |- Severity applied to every test this rule deploys, unless a RuleTest overrides it. Required — must be set to a value other than unspecified. schema: $ref: '#/components/schemas/synq.datachecks.sqltests.v1.Severity' not: enum: - 0 title: severity description: >- Severity applied to every test this rule deploys, unless a RuleTest overrides it. Required — must be set to a value other than unspecified. - name: deploymentRule.staticConfig.saveFailures in: query description: >- Applied to every test this rule deploys. Toggles saving of failure runs. schema: type: boolean title: save_failures description: >- Applied to every test this rule deploys. Toggles saving of failure runs. - name: deploymentRule.exclusiveStaticConfig.path in: query description: Synq path of the table or view this rule exclusively owns. schema: type: string title: path description: Synq path of the table or view this rule exclusively owns. - name: deploymentRule.source in: query schema: $ref: '#/components/schemas/synq.v1.Source' title: source - name: deploymentRule.configId in: query description: >- Config ID this rule was authored from, when deployed via configuration as code. Unset for rules authored directly through this API. schema: type: string title: config_id description: >- Config ID this rule was authored from, when deployed via configuration as code. Unset for rules authored directly through this API. responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.GetSqlTestDeployOverviewResponse components: schemas: synq.entities.v1.EntityType: type: string title: EntityType enum: - ENTITY_TYPE_UNSPECIFIED - ENTITY_TYPE_BQ_TABLE - ENTITY_TYPE_BQ_VIEW - ENTITY_TYPE_LOOKER_LOOK - ENTITY_TYPE_LOOKER_EXPLORE - ENTITY_TYPE_LOOKER_VIEW - ENTITY_TYPE_LOOKER_DASHBOARD - ENTITY_TYPE_DBT_MODEL - ENTITY_TYPE_DBT_TEST - ENTITY_TYPE_DBT_SOURCE - ENTITY_TYPE_DBT_PROJECT - ENTITY_TYPE_DBT_METRIC - ENTITY_TYPE_DBT_SNAPSHOT - ENTITY_TYPE_DBT_SEED - ENTITY_TYPE_DBT_ANALYSIS - ENTITY_TYPE_DBT_EXPOSURE - ENTITY_TYPE_DBT_GROUP - ENTITY_TYPE_DBT_SEMANTIC_MODEL - ENTITY_TYPE_DBT_CLOUD_PROJECT - ENTITY_TYPE_DBT_CLOUD_JOB - ENTITY_TYPE_SNOWFLAKE_TABLE - ENTITY_TYPE_SNOWFLAKE_VIEW - ENTITY_TYPE_SNOWFLAKE_STREAM - ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE - ENTITY_TYPE_SNOWFLAKE_TASK - ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE - ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW - ENTITY_TYPE_SNOWFLAKE_PROCEDURE - ENTITY_TYPE_SNOWFLAKE_FUNCTION - ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW - ENTITY_TYPE_REDSHIFT_TABLE - ENTITY_TYPE_REDSHIFT_VIEW - ENTITY_TYPE_REDSHIFT_PROCEDURE - ENTITY_TYPE_REDSHIFT_FUNCTION - ENTITY_TYPE_TABLEAU_EMBEDDED - ENTITY_TYPE_TABLEAU_PUBLISHED - ENTITY_TYPE_TABLEAU_CUSTOM_SQL - ENTITY_TYPE_TABLEAU_TABLE - ENTITY_TYPE_TABLEAU_SHEET - ENTITY_TYPE_TABLEAU_DASHBOARD - ENTITY_TYPE_AIRFLOW_DAG - ENTITY_TYPE_AIRFLOW_TASK - ENTITY_TYPE_CLICKHOUSE_TABLE - ENTITY_TYPE_CLICKHOUSE_VIEW - ENTITY_TYPE_ANOMALY_MONITOR - ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT - ENTITY_TYPE_SQLTEST_TEST - ENTITY_TYPE_RECON_SUITE - ENTITY_TYPE_RECON_CASE - ENTITY_TYPE_POSTGRES_TABLE - ENTITY_TYPE_POSTGRES_VIEW - ENTITY_TYPE_MYSQL_TABLE - ENTITY_TYPE_MYSQL_VIEW - ENTITY_TYPE_DATABRICKS_WAREHOUSE - ENTITY_TYPE_DATABRICKS_TABLE - ENTITY_TYPE_DATABRICKS_VIEW - ENTITY_TYPE_DATABRICKS_JOB - ENTITY_TYPE_DATABRICKS_JOB_TASK - ENTITY_TYPE_DATABRICKS_NOTEBOOK - ENTITY_TYPE_DATABRICKS_QUERY - ENTITY_TYPE_DATABRICKS_DASHBOARD - ENTITY_TYPE_SQLMESH_PROJECT - ENTITY_TYPE_SQLMESH_SQL_MODEL - ENTITY_TYPE_SQLMESH_PYTHON_MODEL - ENTITY_TYPE_SQLMESH_EXTERNAL - ENTITY_TYPE_SQLMESH_SEED - ENTITY_TYPE_SQLMESH_AUDIT - ENTITY_TYPE_SQLMESH_UNIT_TEST - ENTITY_TYPE_SQLMESH_ENVIRONMENT - ENTITY_TYPE_SQLMESH_SNAPSHOT - ENTITY_TYPE_DUCKDB_TABLE - ENTITY_TYPE_DUCKDB_VIEW - ENTITY_TYPE_TRINO_TABLE - ENTITY_TYPE_TRINO_VIEW - ENTITY_TYPE_ATLAN_ASSET - ENTITY_TYPE_ATLAN_INTEGRATION - ENTITY_TYPE_COALESCE_PROJECT - ENTITY_TYPE_COALESCE_ENVIRONMENT - ENTITY_TYPE_COALESCE_NODE - ENTITY_TYPE_COALESCE_NODE_TEST - ENTITY_TYPE_COALESCE_JOB - ENTITY_TYPE_CASTORDOC_TABLE - ENTITY_TYPE_CASTORDOC_DASHBOARD - ENTITY_TYPE_CASTORDOC_VIEW - ENTITY_TYPE_CASTORDOC_TILE - ENTITY_TYPE_CASTORDOC_VIZ_MODEL - ENTITY_TYPE_POWERBI_REPORT - ENTITY_TYPE_POWERBI_TILE - ENTITY_TYPE_POWERBI_DATASET - ENTITY_TYPE_POWERBI_DASHBOARD - ENTITY_TYPE_POWERBI_TENANT - ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD - ENTITY_TYPE_THOUGHTSPOT_WORKSHEET - ENTITY_TYPE_SIGMA_WORKBOOK - ENTITY_TYPE_SIGMA_DATA_MODEL - ENTITY_TYPE_SIGMA_ORGANIZATION - ENTITY_TYPE_DOMO_PAGE - ENTITY_TYPE_DOMO_DATASET - ENTITY_TYPE_MSSQL_TABLE - ENTITY_TYPE_MSSQL_VIEW - ENTITY_TYPE_ORACLE_TABLE - ENTITY_TYPE_ORACLE_VIEW - ENTITY_TYPE_ATHENA_TABLE - ENTITY_TYPE_ATHENA_VIEW - ENTITY_TYPE_FABRIC_TABLE - ENTITY_TYPE_FABRIC_VIEW - ENTITY_TYPE_CUSTOM_ENTITY_GENERIC - ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN - ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX synq.platforms.v1.DataPlatformType: type: string title: DataPlatformType enum: - DATA_PLATFORM_TYPE_UNSPECIFIED - DATA_PLATFORM_TYPE_BIGQUERY - DATA_PLATFORM_TYPE_LOOKER - DATA_PLATFORM_TYPE_DBT - DATA_PLATFORM_TYPE_DBT_CLOUD - DATA_PLATFORM_TYPE_DBT_SELF_HOSTED - DATA_PLATFORM_TYPE_SNOWFLAKE - DATA_PLATFORM_TYPE_GCP - DATA_PLATFORM_TYPE_GIT - DATA_PLATFORM_TYPE_GITHUB - DATA_PLATFORM_TYPE_REDSHIFT - DATA_PLATFORM_TYPE_TABLEAU - DATA_PLATFORM_TYPE_AIRFLOW - DATA_PLATFORM_TYPE_CLICKHOUSE - DATA_PLATFORM_TYPE_POSTGRES - DATA_PLATFORM_TYPE_MYSQL - DATA_PLATFORM_TYPE_DATABRICKS - DATA_PLATFORM_TYPE_SQLMESH - DATA_PLATFORM_TYPE_DUCKDB - DATA_PLATFORM_TYPE_TRINO - DATA_PLATFORM_TYPE_ATLAN - DATA_PLATFORM_TYPE_COALESCE - DATA_PLATFORM_TYPE_CASTORDOC - DATA_PLATFORM_TYPE_POWERBI - DATA_PLATFORM_TYPE_THOUGHTSPOT - DATA_PLATFORM_TYPE_SIGMA - DATA_PLATFORM_TYPE_DOMO - DATA_PLATFORM_TYPE_MSSQL - DATA_PLATFORM_TYPE_ORACLE - DATA_PLATFORM_TYPE_ATHENA - DATA_PLATFORM_TYPE_FABRIC - DATA_PLATFORM_TYPE_SYNQ synq.queries.v1.QueryOperand: type: string title: QueryOperand enum: - QUERY_OPERAND_UNSPECIFIED - QUERY_OPERAND_AND - QUERY_OPERAND_OR - QUERY_OPERAND_EXCEPT - QUERY_OPERAND_UPSTREAM - QUERY_OPERAND_DOWNSTREAM description: >- QueryOperand defines how multiple QueryParts within a Query are combined. synq.datachecks.sqltests.v1.Severity: type: string title: Severity enum: - SEVERITY_UNSPECIFIED - SEVERITY_WARNING - SEVERITY_ERROR - SEVERITY_INFO synq.v1.Source: type: string title: Source enum: - SOURCE_APP - SOURCE_API synq.datachecks.sqltests.v1.GetSqlTestDeployOverviewResponse: type: object properties: overview: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview title: GetSqlTestDeployOverviewResponse additionalProperties: false synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview: type: object properties: testsToCreate: type: array items: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.SqlTestDeploymentChange description: Tests that would be newly created by this deploy. testsToUpdate: type: array items: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.SqlTestDeploymentChange description: >- Tests that already exist and would be updated (e.g. a changed severity or template) by this deploy. testsToDelete: type: array items: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.SqlTestDeploymentChange description: >- Tests that would be deleted by this deploy, because their table or view no longer matches the rule's selection. testsToKeep: type: array items: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.SqlTestDeploymentChange description: Tests that already exist, still match, and would be left unchanged. skippedTables: type: array items: $ref: >- #/components/schemas/synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview.SkippedTable description: Tables or views this rule matched but could not deploy tests onto. title: SqlTestsDeploymentOverview additionalProperties: false description: |- SqlTestsDeploymentOverview previews or reports the effect of deploying a SqlTestDeploymentRule, per test rather than per table — a table with three tests deployed appears as three entries, one for each test. synq.datachecks.sqltests.v1.SqlTestDeploymentChange: type: object properties: tablePath: type: string description: Synq path of the table or view the test targets or would target. sqlTestPath: type: string description: >- Synq path of the SqlTest, when it already exists (create-side changes may leave this empty until the test is actually deployed). testName: type: string description: >- Name of the test, resolved from its RuleTest.name (or the generated name for non-business test kinds). title: SqlTestDeploymentChange additionalProperties: false description: >- SqlTestDeploymentChange describes one test's planned or applied change for a single table or view within a SqlTestsDeploymentOverview. synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview.SkippedTable: type: object properties: tablePath: type: string description: Synq path of the skipped table or view. reason: type: string description: Human-readable reason the table or view was skipped. title: SkippedTable additionalProperties: false description: >- SkippedTable names a table or view the rule's selection matched, but that this deploy could not deploy tests onto. securitySchemes: bearerAuth: type: http scheme: bearer ````