{ "components": { "schemas": { "APIPrDetails": { "properties": { "base_branch": { "title": "Base Branch", "type": "string" }, "base_sha": { "title": "Base Sha", "type": "string" }, "pr_branch": { "title": "Pr Branch", "type": "string" }, "pr_number": { "title": "Pr Number", "type": "integer" }, "pr_sha": { "title": "Pr Sha", "type": "string" } }, "required": [ "pr_number", "pr_branch", "base_branch", "pr_sha", "base_sha" ], "title": "APIPrDetails", "type": "object" }, "AWSS3Config": { "properties": { "bucket_name": { "title": "Bucket Name", "type": "string" }, "key_id": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Key Id" }, "materialize_max_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Materialize Max Rows" }, "materialize_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Materialize Path" }, "region": { "title": "Region", "type": "string" }, "secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Secret" } }, "required": [ "bucket_name", "key_id", "region" ], "title": "AWSS3Config", "type": "object" }, "AbsoluteColumnTolerance": { "properties": { "type": { "const": "absolute", "default": "absolute", "description": "The type of Column Tolerance.", "title": "Type", "type": "string" }, "value": { "description": "Value of Column Tolerance.", "title": "Value", "type": "number" } }, "required": [ "value" ], "title": "Absolute", "type": "object" }, "AbsoluteThreshold": { "properties": { "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Maximum value for the absolute threshold.", "title": "Max" }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Minimum value for the absolute threshold.", "title": "Min" }, "type": { "const": "absolute", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Absolute", "type": "object" }, "AnomalyDetectionThreshold": { "properties": { "anomaly_direction": { "anyOf": [ { "$ref": "#/components/schemas/AnomalyThresholdTypes" }, { "type": "null" } ], "description": "Which side of the ML band alerts: 'lower', 'upper', or 'lower_and_upper' (both). Omitted / null = both (server default)." }, "sensitivity": { "description": "Sensitivity level for anomaly detection, ranging from 0 to 100.", "maximum": 100.0, "minimum": 0.0, "title": "Sensitivity", "type": "integer" }, "type": { "const": "automatic", "title": "Type", "type": "string" } }, "required": [ "type", "sensitivity" ], "title": "Anomaly Detection", "type": "object" }, "AnomalyThresholdTypes": { "enum": [ "lower", "upper", "lower_and_upper" ], "title": "AnomalyThresholdTypes", "type": "string" }, "ApiCIDependency": { "properties": { "data_source_id": { "title": "Data Source Id", "type": "integer" }, "data_source_type": { "title": "Data Source Type", "type": "string" }, "item_type": { "title": "Item Type", "type": "string" }, "name": { "title": "Name", "type": "string" }, "path": { "items": { "type": "string" }, "title": "Path", "type": "array" }, "popularity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Popularity" }, "primary_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Key" }, "query_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query Type" }, "raw_sql": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Raw Sql" }, "remote_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remote Id" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name" }, "uid": { "title": "Uid", "type": "string" } }, "required": [ "uid", "item_type", "name", "path", "data_source_id", "data_source_type" ], "title": "ApiCIDependency", "type": "object" }, "ApiCiRun": { "properties": { "base_branch": { "title": "Base Branch", "type": "string" }, "base_sha": { "title": "Base Sha", "type": "string" }, "id": { "title": "Id", "type": "integer" }, "pr_branch": { "title": "Pr Branch", "type": "string" }, "pr_num": { "title": "Pr Num", "type": "string" }, "pr_sha": { "title": "Pr Sha", "type": "string" }, "source": { "title": "Source", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "base_branch", "base_sha", "pr_branch", "pr_sha", "pr_num", "status", "source" ], "title": "ApiCiRun", "type": "object" }, "ApiColumnDiffStat": { "properties": { "column_name": { "title": "Column Name", "type": "string" }, "match": { "description": "Percentage of cells that matched (0-100)", "title": "Match", "type": "number" }, "values_different": { "description": "Count of different cells observed in the sample", "title": "Values Different", "type": "integer" }, "values_different_estimate": { "anyOf": [ { "$ref": "#/components/schemas/ApiEstimatedIntValue" }, { "type": "null" } ], "description": "Statistical estimate of differences for the full dataset. Only present when sampling was applied. Includes observed value, extrapolated estimate, confidence level, and confidence interval bounds." } }, "required": [ "column_name", "match", "values_different" ], "title": "ApiColumnDiffStat", "type": "object" }, "ApiColumnProfileStats": { "properties": { "distinct": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Approximate distinct value count", "title": "Distinct" }, "histogram_bins": { "default": 0, "description": "Number of histogram bins available (0 if no histogram)", "title": "Histogram Bins", "type": "integer" }, "max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Maximum value (formatted as string)", "title": "Max" }, "min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Minimum value (formatted as string)", "title": "Min" }, "nulls": { "description": "Number of NULL values", "title": "Nulls", "type": "integer" }, "top_values_count": { "default": 0, "description": "Number of top enum values available (0 if no enums)", "title": "Top Values Count", "type": "integer" }, "total": { "description": "Total number of rows in exclusive set", "title": "Total", "type": "integer" } }, "required": [ "total", "nulls" ], "title": "ApiColumnProfileStats", "type": "object" }, "ApiColumnRule": { "properties": { "column": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Column name the rule applies to, matched case-insensitively. When column remapping is enabled, this refers to the dataset-A (canonical) column name \u2014 the same name the comparator operates on after remapping. A selector matching no compared column applies nothing and is logged as a warning. Mutually exclusive with `type`. Exactly one of `column` or `type` must be set.", "title": "Column" }, "equal_if": { "description": "SQL boolean expression OR-ed into the value comparator for the matching column(s). Use {a} and {b} as placeholders for the side-A and side-B column references. Multiple rules matching the same column are all OR-ed together.", "title": "Equal If", "type": "string" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/DatatypeName" }, { "type": "null" } ], "description": "Type-based selector \u2014 matches all columns whose Datatype.typename equals this value, resolved against the types the comparison actually runs on (the source warehouse types for same-database diffs, the negotiated DuckDB types for cross-database diffs). Mutually exclusive with `column`." } }, "required": [ "equal_if" ], "title": "ApiColumnRule", "type": "object" }, "ApiCrossDataDiffSummaryForDone": { "description": "Cross-database counterpart of `ApiDataDiffSummaryForDone` (returned when the diff ran\non a cross-database engine \u2014 any algorithm other than `join`; an unset algorithm is\ntreated as same-database).\n\nDeliberately narrower than the same-database variant: there is **no `schema` field**,\nand `diff_stats.diff_schema` on the diff object is 0 for every cross-database diff.\nNeither field means \"the schemas match\" \u2014 schema drift is simply not reported on this\nsurface. The comparison itself does compute a schema diff; to read it use the MCP tools\n`get_datadiff_overview` (its `schema` section) or `get_datadiff_result_section` with\nsection=\"columns\" (per-column types), both of which cover cross-database diffs.", "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the diff was created.", "title": "Created At" }, "data_source1_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source of dataset A (\"t1\").", "title": "Data Source1 Id" }, "data_source2_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source of dataset B (\"t2\").", "title": "Data Source2 Id" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns excluded from the comparison.", "title": "Exclude Columns" }, "file1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File URI for dataset A, when compared as a file.", "title": "File1" }, "file2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File URI for dataset B, when compared as a file.", "title": "File2" }, "filter1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Row filter applied to dataset A.", "title": "Filter1" }, "filter2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Row filter applied to dataset B.", "title": "Filter2" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns compared (all shared columns if empty).", "title": "Include Columns" }, "materialized_results": { "$ref": "#/components/schemas/ApiMaterializedResults", "description": "Results of the diff, materialized into tables." }, "pk_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Primary key column names used for this diff.", "title": "Pk Columns" }, "pks": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataDiffSummaryPKs" }, { "type": "null" } ] }, "query1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL for dataset A, when compared as a query.", "title": "Query1" }, "query2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL for dataset B, when compared as a query.", "title": "Query2" }, "sampling_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling ratio; null when the diff was not sampled.", "title": "Sampling Ratio" }, "status": { "enum": [ "done", "success" ], "title": "Status", "type": "string" }, "table1": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Path segments of dataset A, when a table.", "title": "Table1" }, "table2": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Path segments of dataset B, when a table.", "title": "Table2" }, "values": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataDiffSummaryValues" }, { "type": "null" } ] } }, "required": [ "status" ], "title": "ApiCrossDataDiffSummaryForDone", "type": "object" }, "ApiDataDiffCancelled": { "properties": { "id": { "title": "Id", "type": "integer" }, "status": { "$ref": "#/components/schemas/JobStatus" } }, "required": [ "id", "status" ], "title": "ApiDataDiffCancelled", "type": "object" }, "ApiDataDiffData": { "properties": { "archived": { "default": false, "title": "Archived", "type": "boolean" }, "bisection_factor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bisection Factor" }, "bisection_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bisection Threshold" }, "column_mapping": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "Map columns with different names between datasets. List of [column_in_A, column_in_B] pairs.", "title": "Column Mapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the in-memory diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. See `ApiColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to compare between datasets. If set, only these columns are diffed (primary key columns are always included). Column names must match the dataset schema.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "data_source1_id": { "description": "ID of the first data source (Dataset A).", "title": "Data Source1 Id", "type": "integer" }, "data_source1_session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Snowflake session parameters for Dataset A, e.g. {\"QUERY_TAG\": \"datadiff\", \"WAREHOUSE\": \"COMPUTE_WH\"}.", "title": "Data Source1 Session Parameters" }, "data_source2_id": { "description": "ID of the second data source (Dataset B). Can be the same as data_source1_id.", "title": "Data Source2 Id", "type": "integer" }, "data_source2_session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Snowflake session parameters for Dataset B.", "title": "Data Source2 Session Parameters" }, "datetime_tolerance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Datetime precision for comparison. 0=seconds, 1=tenths, 2=hundredths, 3=milliseconds, 4=tenth-ms, 5=hundredth-ms, 6=microseconds.", "title": "Datetime Tolerance" }, "diff_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Default tolerance for float comparisons. In absolute mode: values within this distance are equal. In relative mode: fraction of difference allowed.", "title": "Diff Tolerance" }, "diff_tolerances_per_column": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnTolerance" }, "type": "array" }, { "type": "null" } ], "description": "Per-column tolerance overrides. Each entry: {column_name, tolerance_value (>= 0), tolerance_mode: 'absolute'|'relative'}.", "title": "Diff Tolerances Per Column" }, "download_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Download Limit" }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior.", "title": "Empty Tables Match" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to exclude from comparison. Ignored if include_columns is set.", "title": "Exclude Columns" }, "file1": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "File URL for Dataset A (s3://, gs://, abfss://, https://). Mutually exclusive with table1 and query1. Requires file1_options.", "title": "File1" }, "file1_options": { "anyOf": [ { "discriminator": { "mapping": { "csv": "#/components/schemas/CSVFileOptions", "excel": "#/components/schemas/ExcelFileOptions", "parquet": "#/components/schemas/ParquetFileOptions" }, "propertyName": "file_type" }, "oneOf": [ { "$ref": "#/components/schemas/CSVFileOptions" }, { "$ref": "#/components/schemas/ExcelFileOptions" }, { "$ref": "#/components/schemas/ParquetFileOptions" } ] }, { "type": "null" } ], "description": "File format options for file1 (file_type, delimiter, sheet, skip rows).", "title": "File1 Options" }, "file2": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "File URL for Dataset B (s3://, gs://, abfss://, https://). Mutually exclusive with table2 and query2. Requires file2_options.", "title": "File2" }, "file2_options": { "anyOf": [ { "discriminator": { "mapping": { "csv": "#/components/schemas/CSVFileOptions", "excel": "#/components/schemas/ExcelFileOptions", "parquet": "#/components/schemas/ParquetFileOptions" }, "propertyName": "file_type" }, "oneOf": [ { "$ref": "#/components/schemas/CSVFileOptions" }, { "$ref": "#/components/schemas/ExcelFileOptions" }, { "$ref": "#/components/schemas/ParquetFileOptions" } ] }, { "type": "null" } ], "description": "File format options for file2 (file_type, delimiter, sheet, skip rows).", "title": "File2 Options" }, "filter1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL WHERE clause for Dataset A (omit the WHERE keyword), e.g. 'status = 1'.", "title": "Filter1" }, "filter2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL WHERE clause for Dataset B (omit the WHERE keyword), e.g. 'status = 1'.", "title": "Filter2" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Explicit list of columns to compare. If set, only these columns are diffed.", "title": "Include Columns" }, "infer_pk": { "default": false, "description": "Infer primary key columns automatically before running the diff. When true, pk_columns may be omitted; the inferred PK is stored back on the diff. Supported configurations: in-db diffs (all input types); cross-db diffs with query inputs on both sides (PK is inferred inside DuckDB after fetch); and cross-db diffs with a table input on either side, where the PK is inferred against the source warehouse before the fetch (requires the primary-key-inference feature to be enabled for your organization). Not supported: file-based diffs \u2014 use POST /api/v1/data_sources/{id}/guess_pk and pass pk_columns explicitly. For in-db query inputs, materialization is auto-forced.", "title": "Infer Pk", "type": "boolean" }, "infer_pk_avoid_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Column names to skip during PK inference. Matched case-insensitively against actual column names (exact match, no glob/regex). Requires infer_pk=true and pk_columns empty; rejected with 422 otherwise.", "title": "Infer Pk Avoid Names" }, "infer_pk_avoid_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Extra column types to skip during PK inference, on top of the built-in defaults (float, timestamp, array, boolean, binary, unsupported). Use canonical type names (e.g. 'integer', 'text') or 'db:' to target a raw warehouse type (e.g. 'db:JSONB'). Requires infer_pk=true and pk_columns empty; rejected with 422 otherwise.", "title": "Infer Pk Avoid Types" }, "materialization_destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source ID where materialized diff results are stored.", "title": "Materialization Destination Id" }, "materialize_dataset1": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Materialize Dataset A before diffing. Improves speed for heavy queries, filtered non-indexed columns, or transformed primary keys.", "title": "Materialize Dataset1" }, "materialize_dataset2": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Materialize Dataset B before diffing. Same use cases as materialize_dataset1.", "title": "Materialize Dataset2" }, "materialize_without_sampling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Skip sampling when materializing results.", "title": "Materialize Without Sampling" }, "per_column_diff_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Per Column Diff Limit" }, "pk_columns": { "description": "Column names that uniquely identify rows, e.g. ['id'] or ['tenant_id', 'order_id']. Must match actual column names in both datasets. Leave empty and set infer_pk=True to auto-detect.", "items": { "type": "string" }, "title": "Pk Columns", "type": "array" }, "purged": { "default": false, "title": "Purged", "type": "boolean" }, "query1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL query for Dataset A. Mutually exclusive with table1 and file1.", "title": "Query1" }, "query2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL query for Dataset B. Mutually exclusive with table2 and file2.", "title": "Query2" }, "run_profiles": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Run column profiling on diff results.", "title": "Run Profiles" }, "sampling_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling confidence level, between 0 and 100 exclusive. Common values: 90, 95, 99, 99.5, 99.9. Use with sampling_tolerance.", "title": "Sampling Confidence" }, "sampling_max_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of rows to sample (absolute count). Alternative to tolerance+confidence and sampling_ratio.", "title": "Sampling Max Rows" }, "sampling_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sample this fraction of rows. Value between 0 and 1 exclusive (e.g. 0.1 = 10% of rows). Alternative to tolerance+confidence.", "title": "Sampling Ratio" }, "sampling_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Minimum row count to activate sampling. Sampling is disabled if the largest table has fewer rows than this.", "title": "Sampling Threshold" }, "sampling_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling tolerance: max fraction of rows with PK errors before sampling is disabled. Value between 0 and 1 exclusive (e.g. 0.001 = 0.1%). Use with sampling_confidence.", "title": "Sampling Tolerance" }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "table1": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Table path for Dataset A as a list of path components, e.g. ['schema', 'table'] or ['database', 'schema', 'table']. Mutually exclusive with query1 and file1.", "title": "Table1" }, "table2": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Table path for Dataset B as a list of path components, e.g. ['schema', 'table'] or ['database', 'schema', 'table']. Mutually exclusive with query2 and file2.", "title": "Table2" }, "table_modifiers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TableModifiers" }, "type": "array" }, { "type": "null" } ], "description": "Table-level modifiers. Allowed values: 'case_insensitive_strings' (ignore string case), 'null_equals_empty_string' (treat NULL and empty string as equal when one warehouse uses NULL and another uses '' for missing text).", "title": "Table Modifiers" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags for organizing and filtering diffs.", "title": "Tags" }, "time_aggregate": { "anyOf": [ { "$ref": "#/components/schemas/TimeAggregateEnum" }, { "type": "null" } ], "description": "Time aggregation level when using time_column." }, "time_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Column name used for time-based filtering or aggregation.", "title": "Time Column" }, "time_interval_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Time Interval End" }, "time_interval_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Time Interval Start" }, "time_travel_point1": { "anyOf": [ { "type": "integer" }, { "format": "date-time", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Time travel point for Dataset A. Accepts: negative integer offset (e.g. -130), UTC timestamp (e.g. '2024-01-15T00:00:00'), or a time point hash. Only supported by Snowflake and Databricks.", "title": "Time Travel Point1" }, "time_travel_point2": { "anyOf": [ { "type": "integer" }, { "format": "date-time", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Time travel point for Dataset B. Same format as time_travel_point1.", "title": "Time Travel Point2" }, "tolerance_mode": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceModeEnum" }, { "type": "null" } ], "description": "How diff_tolerance is applied: 'absolute' or 'relative'." } }, "required": [ "data_source1_id", "data_source2_id" ], "title": "ApiDataDiffData", "type": "object" }, "ApiDataDiffError": { "properties": { "error_type": { "title": "Error Type", "type": "string" }, "error_value": { "title": "Error Value", "type": "string" }, "is_retryable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Retryable" } }, "required": [ "error_type", "error_value" ], "title": "ApiDataDiffError", "type": "object" }, "ApiDataDiffFull": { "properties": { "affected_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Affected Columns" }, "algorithm": { "anyOf": [ { "$ref": "#/components/schemas/DiffAlgorithm" }, { "type": "null" } ], "description": "Diff algorithm. 'join' for same-database diffs, 'fetch_and_join' for cross-database or file diffs. Auto-selected if omitted: 'join' when both data sources are the same, 'fetch_and_join' otherwise." }, "archived": { "default": false, "title": "Archived", "type": "boolean" }, "bisection_factor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bisection Factor" }, "bisection_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bisection Threshold" }, "ci_base_branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Base Branch" }, "ci_pr_branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Branch" }, "ci_pr_num": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ci Pr Num" }, "ci_pr_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Sha" }, "ci_pr_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Url" }, "ci_pr_user_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr User Display Name" }, "ci_pr_user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr User Email" }, "ci_pr_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr User Id" }, "ci_pr_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Username" }, "ci_run_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ci Run Id" }, "ci_sha_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Sha Url" }, "column_mapping": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "Map columns with different names between datasets. List of [column_in_A, column_in_B] pairs.", "title": "Column Mapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the in-memory diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. See `ApiColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to compare between datasets. If set, only these columns are diffed (primary key columns are always included). Column names must match the dataset schema.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "data_app_metadata": { "anyOf": [ { "$ref": "#/components/schemas/TDataDiffDataAppMetadata" }, { "type": "null" } ] }, "data_app_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data App Type" }, "data_source1_id": { "description": "ID of the first data source (Dataset A).", "title": "Data Source1 Id", "type": "integer" }, "data_source1_session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Snowflake session parameters for Dataset A, e.g. {\"QUERY_TAG\": \"datadiff\", \"WAREHOUSE\": \"COMPUTE_WH\"}.", "title": "Data Source1 Session Parameters" }, "data_source2_id": { "description": "ID of the second data source (Dataset B). Can be the same as data_source1_id.", "title": "Data Source2 Id", "type": "integer" }, "data_source2_session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Snowflake session parameters for Dataset B.", "title": "Data Source2 Session Parameters" }, "datetime_tolerance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Datetime precision for comparison. 0=seconds, 1=tenths, 2=hundredths, 3=milliseconds, 4=tenth-ms, 5=hundredth-ms, 6=microseconds.", "title": "Datetime Tolerance" }, "diff_stats": { "anyOf": [ { "$ref": "#/components/schemas/DiffStats" }, { "type": "null" } ] }, "diff_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Default tolerance for float comparisons. In absolute mode: values within this distance are equal. In relative mode: fraction of difference allowed.", "title": "Diff Tolerance" }, "diff_tolerances_per_column": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnTolerance" }, "type": "array" }, { "type": "null" } ], "description": "Per-column tolerance overrides. Each entry: {column_name, tolerance_value (>= 0), tolerance_mode: 'absolute'|'relative'}.", "title": "Diff Tolerances Per Column" }, "done": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Done" }, "download_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Download Limit" }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior.", "title": "Empty Tables Match" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to exclude from comparison. Ignored if include_columns is set.", "title": "Exclude Columns" }, "execute_as_user": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Execute As User" }, "file1": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "File URL for Dataset A (s3://, gs://, abfss://, https://). Mutually exclusive with table1 and query1. Requires file1_options.", "title": "File1" }, "file1_options": { "anyOf": [ { "discriminator": { "mapping": { "csv": "#/components/schemas/CSVFileOptions", "excel": "#/components/schemas/ExcelFileOptions", "parquet": "#/components/schemas/ParquetFileOptions" }, "propertyName": "file_type" }, "oneOf": [ { "$ref": "#/components/schemas/CSVFileOptions" }, { "$ref": "#/components/schemas/ExcelFileOptions" }, { "$ref": "#/components/schemas/ParquetFileOptions" } ] }, { "type": "null" } ], "description": "File format options for file1 (file_type, delimiter, sheet, skip rows).", "title": "File1 Options" }, "file2": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "File URL for Dataset B (s3://, gs://, abfss://, https://). Mutually exclusive with table2 and query2. Requires file2_options.", "title": "File2" }, "file2_options": { "anyOf": [ { "discriminator": { "mapping": { "csv": "#/components/schemas/CSVFileOptions", "excel": "#/components/schemas/ExcelFileOptions", "parquet": "#/components/schemas/ParquetFileOptions" }, "propertyName": "file_type" }, "oneOf": [ { "$ref": "#/components/schemas/CSVFileOptions" }, { "$ref": "#/components/schemas/ExcelFileOptions" }, { "$ref": "#/components/schemas/ParquetFileOptions" } ] }, { "type": "null" } ], "description": "File format options for file2 (file_type, delimiter, sheet, skip rows).", "title": "File2 Options" }, "filter1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL WHERE clause for Dataset A (omit the WHERE keyword), e.g. 'status = 1'.", "title": "Filter1" }, "filter2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL WHERE clause for Dataset B (omit the WHERE keyword), e.g. 'status = 1'.", "title": "Filter2" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Finished At" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Explicit list of columns to compare. If set, only these columns are diffed.", "title": "Include Columns" }, "infer_pk": { "default": false, "description": "Infer primary key columns automatically before running the diff. When true, pk_columns may be omitted; the inferred PK is stored back on the diff. Supported configurations: in-db diffs (all input types); cross-db diffs with query inputs on both sides (PK is inferred inside DuckDB after fetch); and cross-db diffs with a table input on either side, where the PK is inferred against the source warehouse before the fetch (requires the primary-key-inference feature to be enabled for your organization). Not supported: file-based diffs \u2014 use POST /api/v1/data_sources/{id}/guess_pk and pass pk_columns explicitly. For in-db query inputs, materialization is auto-forced.", "title": "Infer Pk", "type": "boolean" }, "infer_pk_avoid_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Column names to skip during PK inference. Matched case-insensitively against actual column names (exact match, no glob/regex). Requires infer_pk=true and pk_columns empty; rejected with 422 otherwise.", "title": "Infer Pk Avoid Names" }, "infer_pk_avoid_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Extra column types to skip during PK inference, on top of the built-in defaults (float, timestamp, array, boolean, binary, unsupported). Use canonical type names (e.g. 'integer', 'text') or 'db:' to target a raw warehouse type (e.g. 'db:JSONB'). Requires infer_pk=true and pk_columns empty; rejected with 422 otherwise.", "title": "Infer Pk Avoid Types" }, "kind": { "$ref": "#/components/schemas/DiffKind" }, "materialization_destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source ID where materialized diff results are stored.", "title": "Materialization Destination Id" }, "materialize_dataset1": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Materialize Dataset A before diffing. Improves speed for heavy queries, filtered non-indexed columns, or transformed primary keys.", "title": "Materialize Dataset1" }, "materialize_dataset2": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Materialize Dataset B before diffing. Same use cases as materialize_dataset1.", "title": "Materialize Dataset2" }, "materialize_without_sampling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Skip sampling when materializing results.", "title": "Materialize Without Sampling" }, "monitor_error": { "anyOf": [ { "$ref": "#/components/schemas/QueryError" }, { "type": "null" } ] }, "monitor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Monitor Id" }, "monitor_state": { "anyOf": [ { "$ref": "#/components/schemas/MonitorRunState" }, { "type": "null" } ] }, "per_column_diff_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Per Column Diff Limit" }, "pk_columns": { "items": { "type": "string" }, "title": "Pk Columns", "type": "array" }, "purged": { "default": false, "title": "Purged", "type": "boolean" }, "query1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL query for Dataset A. Mutually exclusive with table1 and file1.", "title": "Query1" }, "query2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL query for Dataset B. Mutually exclusive with table2 and file2.", "title": "Query2" }, "result": { "anyOf": [ { "enum": [ "error", "bad-pks", "different", "missing-pks", "identical", "empty" ], "type": "string" }, { "type": "null" } ], "title": "Result" }, "result_revisions": { "additionalProperties": { "type": "integer" }, "default": {}, "title": "Result Revisions", "type": "object" }, "result_statuses": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Result Statuses" }, "run_profiles": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Run column profiling on diff results.", "title": "Run Profiles" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Runtime" }, "sampling_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling confidence level, between 0 and 100 exclusive. Common values: 90, 95, 99, 99.5, 99.9. Use with sampling_tolerance.", "title": "Sampling Confidence" }, "sampling_max_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of rows to sample (absolute count). Alternative to tolerance+confidence and sampling_ratio.", "title": "Sampling Max Rows" }, "sampling_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sample this fraction of rows. Value between 0 and 1 exclusive (e.g. 0.1 = 10% of rows). Alternative to tolerance+confidence.", "title": "Sampling Ratio" }, "sampling_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Minimum row count to activate sampling. Sampling is disabled if the largest table has fewer rows than this.", "title": "Sampling Threshold" }, "sampling_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling tolerance: max fraction of rows with PK errors before sampling is disabled. Value between 0 and 1 exclusive (e.g. 0.001 = 0.1%). Use with sampling_confidence.", "title": "Sampling Tolerance" }, "share_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Token" }, "share_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Url" }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/JobSource" }, { "type": "null" } ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/JobStatus" }, { "type": "null" } ] }, "table1": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Table path for Dataset A as a list of path components, e.g. ['schema', 'table'] or ['database', 'schema', 'table']. Mutually exclusive with query1 and file1.", "title": "Table1" }, "table2": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Table path for Dataset B as a list of path components, e.g. ['schema', 'table'] or ['database', 'schema', 'table']. Mutually exclusive with query2 and file2.", "title": "Table2" }, "table_modifiers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TableModifiers" }, "type": "array" }, { "type": "null" } ], "description": "Table-level modifiers. Allowed values: 'case_insensitive_strings' (ignore string case), 'null_equals_empty_string' (treat NULL and empty string as equal when one warehouse uses NULL and another uses '' for missing text).", "title": "Table Modifiers" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags for organizing and filtering diffs.", "title": "Tags" }, "temp_schema_override": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Temp Schema Override" }, "time_aggregate": { "anyOf": [ { "$ref": "#/components/schemas/TimeAggregateEnum" }, { "type": "null" } ], "description": "Time aggregation level when using time_column." }, "time_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Column name used for time-based filtering or aggregation.", "title": "Time Column" }, "time_interval_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Time Interval End" }, "time_interval_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Time Interval Start" }, "time_travel_point1": { "anyOf": [ { "type": "integer" }, { "format": "date-time", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Time travel point for Dataset A. Accepts: negative integer offset (e.g. -130), UTC timestamp (e.g. '2024-01-15T00:00:00'), or a time point hash. Only supported by Snowflake and Databricks.", "title": "Time Travel Point1" }, "time_travel_point2": { "anyOf": [ { "type": "integer" }, { "format": "date-time", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Time travel point for Dataset B. Same format as time_travel_point1.", "title": "Time Travel Point2" }, "tolerance_mode": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceModeEnum" }, { "type": "null" } ], "description": "How diff_tolerance is applied: 'absolute' or 'relative'." }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id" }, "warnings": { "description": "Non-fatal warnings from creating the diff, e.g. when the requested algorithm was not supported and was overridden. Populated only in the create-diff response; empty when reading an existing diff.", "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "data_source1_id", "data_source2_id", "pk_columns", "kind" ], "title": "ApiDataDiffFull", "type": "object" }, "ApiDataDiffPage": { "properties": { "count": { "title": "Count", "type": "integer" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/ApiDataDiffFull" }, "title": "Results", "type": "array" }, "total_pages": { "title": "Total Pages", "type": "integer" } }, "required": [ "page", "page_size", "count", "total_pages", "results" ], "title": "ApiDataDiffPage", "type": "object" }, "ApiDataDiffSummary": { "description": "Summary of a DataDiff comparison with human-readable feedback.", "properties": { "algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Algorithm" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "data_source1_id": { "title": "Data Source1 Id", "type": "integer" }, "data_source1_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Source1 Name" }, "data_source2_id": { "title": "Data Source2 Id", "type": "integer" }, "data_source2_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Source2 Name" }, "diff_stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Diff Stats" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "feedback": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feedback" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Finished At" }, "id": { "title": "Id", "type": "integer" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include Columns" }, "pk_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Pk Columns" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" }, "result_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Status" }, "results_count": { "default": 0, "title": "Results Count", "type": "integer" }, "sampling_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sampling Ratio" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "table1": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Table1" }, "table2": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Table2" } }, "required": [ "id", "status", "data_source1_id", "data_source2_id" ], "title": "ApiDataDiffSummary", "type": "object" }, "ApiDataDiffSummaryForDone": { "description": "Same-database (`join`, or unset algorithm) summary of a completed diff. Carries the\n`schema` section; its cross-database sibling `ApiCrossDataDiffSummaryForDone` does not \u2014\nsee that model for what is and isn't reported there.", "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the diff was created.", "title": "Created At" }, "data_source1_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source of dataset A (\"t1\").", "title": "Data Source1 Id" }, "data_source2_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source of dataset B (\"t2\").", "title": "Data Source2 Id" }, "dependencies": { "items": { "$ref": "#/components/schemas/ApiCIDependency" }, "title": "Dependencies", "type": "array" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns excluded from the comparison.", "title": "Exclude Columns" }, "exclusives_profile": { "anyOf": [ { "$ref": "#/components/schemas/ApiExclusiveRowsProfile" }, { "type": "null" } ], "description": "Distribution statistics for exclusive rows (rows that exist in one table but not the other). Includes histograms and enum distributions for primary key columns. Only available for diffs computed after October 2025." }, "file1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File URI for dataset A, when compared as a file.", "title": "File1" }, "file2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File URI for dataset B, when compared as a file.", "title": "File2" }, "filter1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Row filter applied to dataset A.", "title": "Filter1" }, "filter2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Row filter applied to dataset B.", "title": "Filter2" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns compared (all shared columns if empty).", "title": "Include Columns" }, "materialized_results": { "$ref": "#/components/schemas/ApiMaterializedResults", "description": "Results of the diff, materialized into tables." }, "pk_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Primary key column names used for this diff.", "title": "Pk Columns" }, "pks": { "$ref": "#/components/schemas/ApiDataDiffSummaryPKs" }, "query1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL for dataset A, when compared as a query.", "title": "Query1" }, "query2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL for dataset B, when compared as a query.", "title": "Query2" }, "sampling_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling ratio; null when the diff was not sampled.", "title": "Sampling Ratio" }, "schema": { "$ref": "#/components/schemas/ApiDataDiffSummarySchema" }, "status": { "enum": [ "done", "success" ], "title": "Status", "type": "string" }, "table1": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Path segments of dataset A, when a table.", "title": "Table1" }, "table2": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Path segments of dataset B, when a table.", "title": "Table2" }, "values": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataDiffSummaryValues" }, { "type": "null" } ] } }, "required": [ "status", "pks", "dependencies", "schema", "materialized_results" ], "title": "ApiDataDiffSummaryForDone", "type": "object" }, "ApiDataDiffSummaryForFailed": { "properties": { "error": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataDiffError" }, { "additionalProperties": true, "type": "object" } ], "title": "Error" }, "status": { "const": "failed", "title": "Status", "type": "string" } }, "required": [ "status", "error" ], "title": "ApiDataDiffSummaryForFailed", "type": "object" }, "ApiDataDiffSummaryForRunning": { "properties": { "status": { "enum": [ "running", "pending" ], "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "ApiDataDiffSummaryForRunning", "type": "object" }, "ApiDataDiffSummaryPKs": { "properties": { "distincts": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Distincts", "type": "array" }, "dupes": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Dupes", "type": "array" }, "exclusives": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Exclusives", "type": "array" }, "nulls": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Nulls", "type": "array" }, "total_rows": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Total Rows", "type": "array" } }, "required": [ "total_rows", "nulls", "dupes", "exclusives", "distincts" ], "title": "ApiDataDiffSummaryPKs", "type": "object" }, "ApiDataDiffSummarySchema": { "description": "Schema-comparison counts. Carried by `ApiDataDiffSummaryForDone` (same-database\ndiffs) only \u2014 the cross-database variant has no `schema` field, see\n`ApiCrossDataDiffSummaryForDone`.\n\nScope: column presence, column order, and data types. Nullability and other column\nconstraints are **not** compared, so a column that only dropped `NOT NULL` counts as\nmatching here.", "properties": { "column_counts": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Column Counts", "type": "array" }, "column_reorders": { "title": "Column Reorders", "type": "integer" }, "column_type_differs": { "items": { "type": "string" }, "title": "Column Type Differs", "type": "array" }, "column_type_mismatches": { "title": "Column Type Mismatches", "type": "integer" }, "columns_mismatched": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "title": "Columns Mismatched", "type": "array" }, "exclusive_columns": { "items": { "items": { "type": "string" }, "type": "array" }, "title": "Exclusive Columns", "type": "array" } }, "required": [ "columns_mismatched", "column_type_mismatches", "column_reorders", "column_counts", "column_type_differs", "exclusive_columns" ], "title": "ApiDataDiffSummarySchema", "type": "object" }, "ApiDataDiffSummaryValues": { "properties": { "columns_diff_stats": { "items": { "$ref": "#/components/schemas/ApiColumnDiffStat" }, "title": "Columns Diff Stats", "type": "array" }, "columns_with_differences": { "title": "Columns With Differences", "type": "integer" }, "compared_columns": { "title": "Compared Columns", "type": "integer" }, "rows_with_differences": { "title": "Rows With Differences", "type": "integer" }, "total_rows": { "title": "Total Rows", "type": "integer" }, "total_values": { "title": "Total Values", "type": "integer" }, "values_with_differences": { "title": "Values With Differences", "type": "integer" } }, "required": [ "total_rows", "rows_with_differences", "total_values", "values_with_differences", "compared_columns", "columns_with_differences", "columns_diff_stats" ], "title": "ApiDataDiffSummaryValues", "type": "object" }, "ApiDataDiffWithProgressState": { "properties": { "affected_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Affected Columns" }, "algorithm": { "anyOf": [ { "$ref": "#/components/schemas/DiffAlgorithm" }, { "type": "null" } ], "description": "Diff algorithm. 'join' for same-database diffs, 'fetch_and_join' for cross-database or file diffs. Auto-selected if omitted: 'join' when both data sources are the same, 'fetch_and_join' otherwise." }, "archived": { "default": false, "title": "Archived", "type": "boolean" }, "bisection_factor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bisection Factor" }, "bisection_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bisection Threshold" }, "ci_base_branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Base Branch" }, "ci_pr_branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Branch" }, "ci_pr_num": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ci Pr Num" }, "ci_pr_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Sha" }, "ci_pr_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Url" }, "ci_pr_user_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr User Display Name" }, "ci_pr_user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr User Email" }, "ci_pr_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr User Id" }, "ci_pr_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Pr Username" }, "ci_run_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ci Run Id" }, "ci_sha_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ci Sha Url" }, "column_mapping": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "Map columns with different names between datasets. List of [column_in_A, column_in_B] pairs.", "title": "Column Mapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the in-memory diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. See `ApiColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to compare between datasets. If set, only these columns are diffed (primary key columns are always included). Column names must match the dataset schema.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "data_app_metadata": { "anyOf": [ { "$ref": "#/components/schemas/TDataDiffDataAppMetadata" }, { "type": "null" } ] }, "data_app_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data App Type" }, "data_source1_id": { "description": "ID of the first data source (Dataset A).", "title": "Data Source1 Id", "type": "integer" }, "data_source1_session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Snowflake session parameters for Dataset A, e.g. {\"QUERY_TAG\": \"datadiff\", \"WAREHOUSE\": \"COMPUTE_WH\"}.", "title": "Data Source1 Session Parameters" }, "data_source2_id": { "description": "ID of the second data source (Dataset B). Can be the same as data_source1_id.", "title": "Data Source2 Id", "type": "integer" }, "data_source2_session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Snowflake session parameters for Dataset B.", "title": "Data Source2 Session Parameters" }, "datetime_tolerance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Datetime precision for comparison. 0=seconds, 1=tenths, 2=hundredths, 3=milliseconds, 4=tenth-ms, 5=hundredth-ms, 6=microseconds.", "title": "Datetime Tolerance" }, "diff_progress": { "anyOf": [ { "$ref": "#/components/schemas/DiffProgress" }, { "type": "null" } ] }, "diff_stats": { "anyOf": [ { "$ref": "#/components/schemas/DiffStats" }, { "type": "null" } ] }, "diff_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Default tolerance for float comparisons. In absolute mode: values within this distance are equal. In relative mode: fraction of difference allowed.", "title": "Diff Tolerance" }, "diff_tolerances_per_column": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnTolerance" }, "type": "array" }, { "type": "null" } ], "description": "Per-column tolerance overrides. Each entry: {column_name, tolerance_value (>= 0), tolerance_mode: 'absolute'|'relative'}.", "title": "Diff Tolerances Per Column" }, "done": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Done" }, "download_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Download Limit" }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior.", "title": "Empty Tables Match" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to exclude from comparison. Ignored if include_columns is set.", "title": "Exclude Columns" }, "execute_as_user": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Execute As User" }, "file1": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "File URL for Dataset A (s3://, gs://, abfss://, https://). Mutually exclusive with table1 and query1. Requires file1_options.", "title": "File1" }, "file1_options": { "anyOf": [ { "discriminator": { "mapping": { "csv": "#/components/schemas/CSVFileOptions", "excel": "#/components/schemas/ExcelFileOptions", "parquet": "#/components/schemas/ParquetFileOptions" }, "propertyName": "file_type" }, "oneOf": [ { "$ref": "#/components/schemas/CSVFileOptions" }, { "$ref": "#/components/schemas/ExcelFileOptions" }, { "$ref": "#/components/schemas/ParquetFileOptions" } ] }, { "type": "null" } ], "description": "File format options for file1 (file_type, delimiter, sheet, skip rows).", "title": "File1 Options" }, "file2": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "File URL for Dataset B (s3://, gs://, abfss://, https://). Mutually exclusive with table2 and query2. Requires file2_options.", "title": "File2" }, "file2_options": { "anyOf": [ { "discriminator": { "mapping": { "csv": "#/components/schemas/CSVFileOptions", "excel": "#/components/schemas/ExcelFileOptions", "parquet": "#/components/schemas/ParquetFileOptions" }, "propertyName": "file_type" }, "oneOf": [ { "$ref": "#/components/schemas/CSVFileOptions" }, { "$ref": "#/components/schemas/ExcelFileOptions" }, { "$ref": "#/components/schemas/ParquetFileOptions" } ] }, { "type": "null" } ], "description": "File format options for file2 (file_type, delimiter, sheet, skip rows).", "title": "File2 Options" }, "filter1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL WHERE clause for Dataset A (omit the WHERE keyword), e.g. 'status = 1'.", "title": "Filter1" }, "filter2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL WHERE clause for Dataset B (omit the WHERE keyword), e.g. 'status = 1'.", "title": "Filter2" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Finished At" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Explicit list of columns to compare. If set, only these columns are diffed.", "title": "Include Columns" }, "infer_pk": { "default": false, "description": "Infer primary key columns automatically before running the diff. When true, pk_columns may be omitted; the inferred PK is stored back on the diff. Supported configurations: in-db diffs (all input types); cross-db diffs with query inputs on both sides (PK is inferred inside DuckDB after fetch); and cross-db diffs with a table input on either side, where the PK is inferred against the source warehouse before the fetch (requires the primary-key-inference feature to be enabled for your organization). Not supported: file-based diffs \u2014 use POST /api/v1/data_sources/{id}/guess_pk and pass pk_columns explicitly. For in-db query inputs, materialization is auto-forced.", "title": "Infer Pk", "type": "boolean" }, "infer_pk_avoid_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Column names to skip during PK inference. Matched case-insensitively against actual column names (exact match, no glob/regex). Requires infer_pk=true and pk_columns empty; rejected with 422 otherwise.", "title": "Infer Pk Avoid Names" }, "infer_pk_avoid_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Extra column types to skip during PK inference, on top of the built-in defaults (float, timestamp, array, boolean, binary, unsupported). Use canonical type names (e.g. 'integer', 'text') or 'db:' to target a raw warehouse type (e.g. 'db:JSONB'). Requires infer_pk=true and pk_columns empty; rejected with 422 otherwise.", "title": "Infer Pk Avoid Types" }, "kind": { "$ref": "#/components/schemas/DiffKind" }, "materialization_destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Data source ID where materialized diff results are stored.", "title": "Materialization Destination Id" }, "materialize_dataset1": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Materialize Dataset A before diffing. Improves speed for heavy queries, filtered non-indexed columns, or transformed primary keys.", "title": "Materialize Dataset1" }, "materialize_dataset2": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Materialize Dataset B before diffing. Same use cases as materialize_dataset1.", "title": "Materialize Dataset2" }, "materialize_without_sampling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Skip sampling when materializing results.", "title": "Materialize Without Sampling" }, "monitor_error": { "anyOf": [ { "$ref": "#/components/schemas/QueryError" }, { "type": "null" } ] }, "monitor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Monitor Id" }, "monitor_state": { "anyOf": [ { "$ref": "#/components/schemas/MonitorRunState" }, { "type": "null" } ] }, "per_column_diff_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Per Column Diff Limit" }, "pk_columns": { "items": { "type": "string" }, "title": "Pk Columns", "type": "array" }, "purged": { "default": false, "title": "Purged", "type": "boolean" }, "query1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL query for Dataset A. Mutually exclusive with table1 and file1.", "title": "Query1" }, "query2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SQL query for Dataset B. Mutually exclusive with table2 and file2.", "title": "Query2" }, "result": { "anyOf": [ { "enum": [ "error", "bad-pks", "different", "missing-pks", "identical", "empty" ], "type": "string" }, { "type": "null" } ], "title": "Result" }, "result_revisions": { "additionalProperties": { "type": "integer" }, "default": {}, "title": "Result Revisions", "type": "object" }, "result_statuses": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Result Statuses" }, "run_profiles": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Run column profiling on diff results.", "title": "Run Profiles" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Runtime" }, "sampling_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling confidence level, between 0 and 100 exclusive. Common values: 90, 95, 99, 99.5, 99.9. Use with sampling_tolerance.", "title": "Sampling Confidence" }, "sampling_max_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of rows to sample (absolute count). Alternative to tolerance+confidence and sampling_ratio.", "title": "Sampling Max Rows" }, "sampling_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sample this fraction of rows. Value between 0 and 1 exclusive (e.g. 0.1 = 10% of rows). Alternative to tolerance+confidence.", "title": "Sampling Ratio" }, "sampling_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Minimum row count to activate sampling. Sampling is disabled if the largest table has fewer rows than this.", "title": "Sampling Threshold" }, "sampling_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling tolerance: max fraction of rows with PK errors before sampling is disabled. Value between 0 and 1 exclusive (e.g. 0.001 = 0.1%). Use with sampling_confidence.", "title": "Sampling Tolerance" }, "share_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Token" }, "share_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Url" }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/JobSource" }, { "type": "null" } ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/JobStatus" }, { "type": "null" } ] }, "table1": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Table path for Dataset A as a list of path components, e.g. ['schema', 'table'] or ['database', 'schema', 'table']. Mutually exclusive with query1 and file1.", "title": "Table1" }, "table2": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Table path for Dataset B as a list of path components, e.g. ['schema', 'table'] or ['database', 'schema', 'table']. Mutually exclusive with query2 and file2.", "title": "Table2" }, "table_modifiers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TableModifiers" }, "type": "array" }, { "type": "null" } ], "description": "Table-level modifiers. Allowed values: 'case_insensitive_strings' (ignore string case), 'null_equals_empty_string' (treat NULL and empty string as equal when one warehouse uses NULL and another uses '' for missing text).", "title": "Table Modifiers" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags for organizing and filtering diffs.", "title": "Tags" }, "temp_schema_override": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Temp Schema Override" }, "time_aggregate": { "anyOf": [ { "$ref": "#/components/schemas/TimeAggregateEnum" }, { "type": "null" } ], "description": "Time aggregation level when using time_column." }, "time_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Column name used for time-based filtering or aggregation.", "title": "Time Column" }, "time_interval_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Time Interval End" }, "time_interval_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Time Interval Start" }, "time_travel_point1": { "anyOf": [ { "type": "integer" }, { "format": "date-time", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Time travel point for Dataset A. Accepts: negative integer offset (e.g. -130), UTC timestamp (e.g. '2024-01-15T00:00:00'), or a time point hash. Only supported by Snowflake and Databricks.", "title": "Time Travel Point1" }, "time_travel_point2": { "anyOf": [ { "type": "integer" }, { "format": "date-time", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Time travel point for Dataset B. Same format as time_travel_point1.", "title": "Time Travel Point2" }, "tolerance_mode": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceModeEnum" }, { "type": "null" } ], "description": "How diff_tolerance is applied: 'absolute' or 'relative'." }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id" }, "warnings": { "description": "Non-fatal warnings from creating the diff, e.g. when the requested algorithm was not supported and was overridden. Populated only in the create-diff response; empty when reading an existing diff.", "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "data_source1_id", "data_source2_id", "pk_columns", "kind" ], "title": "ApiDataDiffWithProgressState", "type": "object" }, "ApiDataSourceAwsAthena": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/AwsAthenaConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "athena", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceAwsAthena", "type": "object" }, "ApiDataSourceAzureDataLake": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/AzureDataLakeConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "files_azure_datalake", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceAzureDataLake", "type": "object" }, "ApiDataSourceAzureSynapse": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/MSSQLConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "azure_synapse", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceAzureSynapse", "type": "object" }, "ApiDataSourceBigQuery": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/BigQueryConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "bigquery", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceBigQuery", "type": "object" }, "ApiDataSourceDB2": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/DB2Config" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "db2", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceDB2", "type": "object" }, "ApiDataSourceDatabricks": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/DatabricksConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "databricks", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceDatabricks", "type": "object" }, "ApiDataSourceDremio": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/DremioConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "dremio", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceDremio", "type": "object" }, "ApiDataSourceDuckDB": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/DuckDBConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "duckdb", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceDuckDB", "type": "object" }, "ApiDataSourceForm": { "discriminator": { "mapping": { "athena": "#/components/schemas/ApiDataSourceAwsAthena", "aws_s3": "#/components/schemas/ApiDataSourceS3", "azure_synapse": "#/components/schemas/ApiDataSourceAzureSynapse", "bigquery": "#/components/schemas/ApiDataSourceBigQuery", "databricks": "#/components/schemas/ApiDataSourceDatabricks", "db2": "#/components/schemas/ApiDataSourceDB2", "dremio": "#/components/schemas/ApiDataSourceDremio", "duckdb": "#/components/schemas/ApiDataSourceDuckDB", "files_azure_datalake": "#/components/schemas/ApiDataSourceAzureDataLake", "google_cloud_storage": "#/components/schemas/ApiDataSourceGCS", "mariadb": "#/components/schemas/ApiDataSourceMariaDB", "microsoft_fabric": "#/components/schemas/ApiDataSourceMicrosoftFabric", "mongodb": "#/components/schemas/ApiDataSourceMongoDB", "mssql": "#/components/schemas/ApiDataSourceMSSQL", "mysql": "#/components/schemas/ApiDataSourceMySQL", "netezza": "#/components/schemas/ApiDataSourceNetezza", "oracle": "#/components/schemas/ApiDataSourceOracle", "pg": "#/components/schemas/ApiDataSourcePostgres", "postgres_aurora": "#/components/schemas/ApiDataSourcePostgresAurora", "postgres_aws_rds": "#/components/schemas/ApiDataSourcePostgresRds", "redshift": "#/components/schemas/ApiDataSourceRedshift", "sap_hana": "#/components/schemas/ApiDataSourceSapHana", "snowflake": "#/components/schemas/ApiDataSourceSnowflake", "starburst": "#/components/schemas/ApiDataSourceStarburst", "teradata": "#/components/schemas/ApiDataSourceTeradata", "trino": "#/components/schemas/ApiDataSourceTrino", "vertica": "#/components/schemas/ApiDataSourceVertica" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ApiDataSourceBigQuery" }, { "$ref": "#/components/schemas/ApiDataSourceDatabricks" }, { "$ref": "#/components/schemas/ApiDataSourceDuckDB" }, { "$ref": "#/components/schemas/ApiDataSourceMongoDB" }, { "$ref": "#/components/schemas/ApiDataSourceMySQL" }, { "$ref": "#/components/schemas/ApiDataSourceMariaDB" }, { "$ref": "#/components/schemas/ApiDataSourceMSSQL" }, { "$ref": "#/components/schemas/ApiDataSourceOracle" }, { "$ref": "#/components/schemas/ApiDataSourcePostgres" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresAurora" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresRds" }, { "$ref": "#/components/schemas/ApiDataSourceRedshift" }, { "$ref": "#/components/schemas/ApiDataSourceTeradata" }, { "$ref": "#/components/schemas/ApiDataSourceSapHana" }, { "$ref": "#/components/schemas/ApiDataSourceDB2" }, { "$ref": "#/components/schemas/ApiDataSourceAwsAthena" }, { "$ref": "#/components/schemas/ApiDataSourceSnowflake" }, { "$ref": "#/components/schemas/ApiDataSourceDremio" }, { "$ref": "#/components/schemas/ApiDataSourceStarburst" }, { "$ref": "#/components/schemas/ApiDataSourceNetezza" }, { "$ref": "#/components/schemas/ApiDataSourceAzureDataLake" }, { "$ref": "#/components/schemas/ApiDataSourceGCS" }, { "$ref": "#/components/schemas/ApiDataSourceS3" }, { "$ref": "#/components/schemas/ApiDataSourceAzureSynapse" }, { "$ref": "#/components/schemas/ApiDataSourceMicrosoftFabric" }, { "$ref": "#/components/schemas/ApiDataSourceVertica" }, { "$ref": "#/components/schemas/ApiDataSourceTrino" } ], "title": "ApiDataSourceForm" }, "ApiDataSourceGCS": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/GCSConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "google_cloud_storage", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceGCS", "type": "object" }, "ApiDataSourceMSSQL": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/MSSQLConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "mssql", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceMSSQL", "type": "object" }, "ApiDataSourceMariaDB": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/MariaDBConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "mariadb", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceMariaDB", "type": "object" }, "ApiDataSourceMicrosoftFabric": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/MicrosoftFabricConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "microsoft_fabric", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceMicrosoftFabric", "type": "object" }, "ApiDataSourceMongoDB": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/MongoDBConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "mongodb", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceMongoDB", "type": "object" }, "ApiDataSourceMySQL": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/MySQLConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "mysql", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceMySQL", "type": "object" }, "ApiDataSourceNetezza": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/NetezzaConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "netezza", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceNetezza", "type": "object" }, "ApiDataSourceOracle": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/OracleConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "oracle", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceOracle", "type": "object" }, "ApiDataSourcePostgres": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/PostgreSQLConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "pg", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourcePostgres", "type": "object" }, "ApiDataSourcePostgresAurora": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/PostgreSQLAuroraConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "postgres_aurora", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourcePostgresAurora", "type": "object" }, "ApiDataSourcePostgresRds": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/PostgreSQLAuroraConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "postgres_aws_rds", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourcePostgresRds", "type": "object" }, "ApiDataSourceRedshift": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/RedshiftConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "redshift", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceRedshift", "type": "object" }, "ApiDataSourceS3": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/AWSS3Config" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "aws_s3", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceS3", "type": "object" }, "ApiDataSourceSapHana": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/SapHanaConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "sap_hana", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceSapHana", "type": "object" }, "ApiDataSourceSnowflake": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/SnowflakeConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "snowflake", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceSnowflake", "type": "object" }, "ApiDataSourceStarburst": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/StarburstConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "starburst", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceStarburst", "type": "object" }, "ApiDataSourceSummary": { "description": "Used in OSS data-diff with non-admin privileges to get a DS overview.", "properties": { "id": { "title": "Id", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "name", "type" ], "title": "ApiDataSourceSummary", "type": "object" }, "ApiDataSourceTeradata": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/TeradataConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "teradata", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceTeradata", "type": "object" }, "ApiDataSourceTestStatus": { "properties": { "results": { "items": { "$ref": "#/components/schemas/TestResultStep" }, "title": "Results", "type": "array" }, "tested_at": { "format": "date-time", "title": "Tested At", "type": "string" } }, "required": [ "tested_at", "results" ], "title": "ApiDataSourceTestStatus", "type": "object" }, "ApiDataSourceTrino": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/TrinoConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "trino", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceTrino", "type": "object" }, "ApiDataSourceType": { "properties": { "configuration_schema": { "additionalProperties": true, "title": "Configuration Schema", "type": "object" }, "default_max_connections": { "title": "Default Max Connections", "type": "integer" }, "features": { "items": { "type": "string" }, "title": "Features", "type": "array" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "name", "type", "configuration_schema", "features", "default_max_connections" ], "title": "ApiDataSourceType", "type": "object" }, "ApiDataSourceVertica": { "properties": { "accessible": { "default": true, "title": "Accessible", "type": "boolean" }, "catalog_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Exclude List" }, "catalog_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Include List" }, "created_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created From" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Retention Days" }, "disable_profiling": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Profiling" }, "disable_schema_indexing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Disable Schema Indexing" }, "float_tolerance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "title": "Float Tolerance" }, "group_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Group Ids" }, "groups": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Groups" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Hidden" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Is Paused" }, "kg_schema_import_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Kg Schema Import Enabled" }, "last_test": { "anyOf": [ { "$ref": "#/components/schemas/ApiDataSourceTestStatus" }, { "type": "null" } ] }, "lineage_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lineage Schedule" }, "max_allowed_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Allowed Connections" }, "name": { "title": "Name", "type": "string" }, "oauth_dwh_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Oauth Dwh Active" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/VerticaConfig" }, { "type": "null" } ] }, "profile_exclude_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Exclude List" }, "profile_include_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Include List" }, "profile_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Schedule" }, "queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Queue Name" }, "scheduled_queue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled Queue Name" }, "schema_indexing_schedule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Indexing Schedule" }, "schema_max_age_s": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schema Max Age S" }, "secret_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Secret Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Schema" }, "type": { "const": "vertica", "title": "Type", "type": "string" }, "view_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "View Only" } }, "required": [ "name", "type" ], "title": "ApiDataSourceVertica", "type": "object" }, "ApiDownloadAuditLogs": { "properties": { "end_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "End Date" }, "start_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, "title": "ApiDownloadAuditLogs", "type": "object" }, "ApiEstimatedIntInterval": { "properties": { "max": { "title": "Max", "type": "integer" }, "min": { "title": "Min", "type": "integer" } }, "required": [ "min", "max" ], "title": "ApiEstimatedIntInterval", "type": "object" }, "ApiEstimatedIntValue": { "properties": { "confidence": { "description": "Confidence level (e.g., 0.95)", "title": "Confidence", "type": "number" }, "estimate": { "description": "Estimated value for full dataset", "title": "Estimate", "type": "integer" }, "interval": { "$ref": "#/components/schemas/ApiEstimatedIntInterval", "description": "Confidence interval bounds" }, "value": { "description": "Observed value in sample", "title": "Value", "type": "integer" } }, "required": [ "value", "estimate", "confidence", "interval" ], "title": "ApiEstimatedIntValue", "type": "object" }, "ApiExclusiveRowsProfile": { "properties": { "t1": { "anyOf": [ { "$ref": "#/components/schemas/ApiTableProfile" }, { "type": "null" } ], "description": "Profile for exclusive rows in table 1" }, "t2": { "anyOf": [ { "$ref": "#/components/schemas/ApiTableProfile" }, { "type": "null" } ], "description": "Profile for exclusive rows in table 2" } }, "title": "ApiExclusiveRowsProfile", "type": "object" }, "ApiGetAuditLogs": { "properties": { "logs": { "items": { "$ref": "#/components/schemas/AuditLogs" }, "title": "Logs", "type": "array" } }, "required": [ "logs" ], "title": "ApiGetAuditLogs", "type": "object" }, "ApiMaterializedResult": { "properties": { "data_source_id": { "description": "Id of the DataSource the results were materialized into", "title": "Data Source Id", "type": "integer" }, "is_sampled": { "description": "If sampling was applied", "title": "Is Sampled", "type": "boolean" }, "path": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Path segments of the table. `None` when the destination is file storage, in which case `url` is set instead.", "title": "Path" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Location of the materialized file, for object-storage destinations (S3/GCS/Azure Data Lake). `None` when the destination is a database, in which case `path` is set instead.", "title": "Url" } }, "required": [ "data_source_id", "is_sampled" ], "title": "ApiMaterializedResult", "type": "object" }, "ApiMaterializedResults": { "properties": { "diff": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiMaterializedResult" }, "type": "array" }, { "type": "null" } ], "description": "Results of row-to-row comparison between dataset A and B. Semantics is the same as for `exclusive_pks1` field.", "title": "Diff" }, "duplicates1": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiMaterializedResult" }, "type": "array" }, { "type": "null" } ], "description": "Rows with duplicate primary keys detected in dataset A. Semantics is the same as for `exclusive_pks1` field.", "title": "Duplicates1" }, "duplicates2": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiMaterializedResult" }, "type": "array" }, { "type": "null" } ], "description": "Rows with duplicate primary keys detected in dataset B. Semantics is the same as for `exclusive_pks1` field.", "title": "Duplicates2" }, "exclusives": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiMaterializedResult" }, "type": "array" }, { "type": "null" } ], "description": "Rows with exclusive primary keys detected in dataset A and B. `None` if table is not ready yet or if materialization wasn't requested. If materialization is completed, for a diff inside a single database the field will contain a list with one element. If diff compares tables in different databases, the list may contain one or two entries.", "title": "Exclusives" } }, "title": "ApiMaterializedResults", "type": "object" }, "ApiPublicCreateMonitorOut": { "properties": { "id": { "description": "Unique identifier for the monitor.", "title": "Id", "type": "integer" } }, "required": [ "id" ], "title": "ApiPublicCreateMonitorOut", "type": "object" }, "ApiPublicGetMonitorOut": { "properties": { "created_at": { "description": "Timestamp when the monitor was created.", "format": "date-time", "title": "Created At", "type": "string" }, "enabled": { "description": "Indicates whether the monitor is enabled.", "title": "Enabled", "type": "boolean" }, "id": { "description": "Unique identifier for the monitor.", "title": "Id", "type": "integer" }, "last_alert": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp of the last alert.", "title": "Last Alert" }, "last_run": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp of the last monitor run.", "title": "Last Run" }, "modified_at": { "description": "Timestamp when the monitor was last modified.", "format": "date-time", "title": "Modified At", "type": "string" }, "monitor_type": { "anyOf": [ { "enum": [ "diff", "metric", "schema", "test" ], "type": "string" }, { "type": "null" } ], "description": "Type of the monitor.", "title": "Monitor Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the monitor.", "title": "Name" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner.", "title": "Owner" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/MonitorRunState" }, { "type": "null" } ], "description": "Current state of the monitor run." }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags associated with the monitor.", "title": "Tags" } }, "required": [ "id", "name", "monitor_type", "created_at", "modified_at", "enabled" ], "title": "ApiPublicGetMonitorOut", "type": "object" }, "ApiPublicGetMonitorOutFull": { "properties": { "alert": { "anyOf": [ { "discriminator": { "mapping": { "absolute": "#/components/schemas/AbsoluteThreshold", "automatic": "#/components/schemas/AnomalyDetectionThreshold", "diff": "#/components/schemas/datafold__api__v1__monitors__DiffAlertCondition", "percentage": "#/components/schemas/PercentageThreshold" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/datafold__api__v1__monitors__DiffAlertCondition" }, { "$ref": "#/components/schemas/AnomalyDetectionThreshold" }, { "$ref": "#/components/schemas/AbsoluteThreshold" }, { "$ref": "#/components/schemas/PercentageThreshold" } ] }, { "type": "null" } ], "description": "Condition for triggering alerts based on the data diff." }, "created_at": { "description": "Timestamp when the monitor was created.", "format": "date-time", "title": "Created At", "type": "string" }, "dataset": { "description": "Dataset configuration for the monitor.", "items": { "$ref": "#/components/schemas/MonitorDataset" }, "title": "Dataset", "type": "array" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "enabled": { "description": "Indicates whether the monitor is enabled.", "title": "Enabled", "type": "boolean" }, "id": { "description": "Unique identifier for the monitor.", "title": "Id", "type": "integer" }, "last_alert": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp of the last alert.", "title": "Last Alert" }, "last_run": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp of the last monitor run.", "title": "Last Run" }, "modified_at": { "description": "Timestamp when the monitor was last modified.", "format": "date-time", "title": "Modified At", "type": "string" }, "monitor_type": { "anyOf": [ { "enum": [ "diff", "metric", "schema", "test" ], "type": "string" }, { "type": "null" } ], "description": "Type of the monitor.", "title": "Monitor Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the monitor.", "title": "Name" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" } ], "description": "The schedule at which the monitor runs." }, "state": { "anyOf": [ { "$ref": "#/components/schemas/MonitorRunState" }, { "type": "null" } ], "description": "Current state of the monitor run." }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags associated with the monitor.", "title": "Tags" } }, "required": [ "id", "name", "monitor_type", "created_at", "modified_at", "enabled", "schedule" ], "title": "ApiPublicGetMonitorOutFull", "type": "object" }, "ApiPublicListMonitorRunsOut": { "properties": { "count": { "description": "Total number of monitor runs.", "title": "Count", "type": "integer" }, "page": { "description": "Current page number in the paginated result.", "title": "Page", "type": "integer" }, "page_size": { "description": "Number of runs per page.", "title": "Page Size", "type": "integer" }, "runs": { "description": "List of monitor runs.", "items": { "$ref": "#/components/schemas/ApiPublicMonitorRunOut" }, "title": "Runs", "type": "array" }, "total_pages": { "description": "Total number of pages available.", "title": "Total Pages", "type": "integer" } }, "required": [ "count", "runs", "page", "page_size", "total_pages" ], "title": "ApiPublicListMonitorRunsOut", "type": "object" }, "ApiPublicListMonitorsOut": { "properties": { "count": { "description": "Total number of monitors.", "title": "Count", "type": "integer" }, "monitors": { "description": "List of monitor details.", "items": { "$ref": "#/components/schemas/ApiPublicGetMonitorOut" }, "title": "Monitors", "type": "array" }, "page": { "description": "Current page number in the paginated result.", "title": "Page", "type": "integer" }, "page_size": { "description": "Number of monitors per page.", "title": "Page Size", "type": "integer" }, "total_pages": { "description": "Total number of pages available.", "title": "Total Pages", "type": "integer" } }, "required": [ "count", "monitors", "page", "page_size", "total_pages" ], "title": "ApiPublicListMonitorsOut", "type": "object" }, "ApiPublicMonitorRunOut": { "properties": { "diff_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Unique identifier for the associated datadiff.", "title": "Diff Id" }, "monitor_id": { "description": "Unique identifier for the associated monitor.", "title": "Monitor Id", "type": "integer" }, "run_id": { "description": "Unique identifier for the monitor run.", "title": "Run Id", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp when the monitor run started.", "title": "Started At" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/MonitorRunState" }, { "type": "null" } ], "description": "Current state of the monitor run." }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp when the monitor run was last updated, e.g. when it finished. Matches `last_run` on the monitor-by-id endpoint for the latest run.", "title": "Updated At" } }, "required": [ "run_id", "monitor_id" ], "title": "ApiPublicMonitorRunOut", "type": "object" }, "ApiPublicMonitorRunResultOut": { "properties": { "diff_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Unique identifier for the associated datadiff.", "title": "Diff Id" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error message if the run encountered an error.", "title": "Error" }, "monitor_id": { "description": "Unique identifier for the associated monitor.", "title": "Monitor Id", "type": "integer" }, "run_id": { "description": "Unique identifier for the monitor run result.", "title": "Run Id", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp when the monitor run started.", "title": "Started At" }, "state": { "$ref": "#/components/schemas/MonitorRunState", "description": "Current state of the monitor run result." }, "warnings": { "description": "List of warning messages generated during the run.", "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "run_id", "monitor_id", "state", "warnings" ], "title": "ApiPublicMonitorRunResultOut", "type": "object" }, "ApiPublicMonitorTriggerRunResultOut": { "properties": { "run_id": { "description": "Unique identifier for the monitor run result.", "title": "Run Id", "type": "integer" } }, "required": [ "run_id" ], "title": "ApiPublicMonitorTriggerRunResultOut", "type": "object" }, "ApiQueryColumn": { "properties": { "db_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Db Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_nullable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Nullable" }, "name": { "title": "Name", "type": "string" }, "number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, "required": [ "name" ], "title": "ApiQueryColumn", "type": "object" }, "ApiQueryRequest": { "properties": { "params": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Positional parameters for parameterized queries", "title": "Params" }, "query": { "description": "SQL query to execute", "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "ApiQueryRequest", "type": "object" }, "ApiQueryResult": { "properties": { "columns": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ApiQueryColumn" }, "type": "array" }, { "type": "null" } ], "title": "Columns" }, "rows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Rows", "type": "array" } }, "required": [ "rows" ], "title": "ApiQueryResult", "type": "object" }, "ApiSortFilters": { "enum": [ "id", "user_id", "user_name", "data_source1_id", "data_source2_id", "table1", "table2", "query1", "query2", "pk_columns", "include_columns", "exclude_columns", "time_column", "time_aggregate", "filter1", "filter2", "done", "time_interval_start", "time_interval_end", "created_at", "updated_at", "diff_stats_pks", "diff_stats_rows", "diff_stats_values", "stats.match_ratio", "tags", "source", "status", "bisection_factor", "bisection_threshold", "ci_type", "ci_run_id", "pr_user_id", "pr_username", "pr_user_email", "pr_user_display_name", "pr_num", "pr_branch", "monitor_id", "data_app_type", "data_app_data_source_id", "data_app_model1_id", "data_app_model2_id", "data_app_model1_name", "data_app_model2_name", "user_ref", "result", "archived", "purged", "kind" ], "title": "ApiSortFilters", "type": "string" }, "ApiSortOrder": { "enum": [ "asc", "desc" ], "title": "ApiSortOrder", "type": "string" }, "ApiTableProfile": { "description": "Profile statistics for exclusive rows in one table.", "properties": { "columns": { "additionalProperties": { "$ref": "#/components/schemas/ApiColumnProfileStats" }, "description": "Map of column name to profile statistics. Only PK columns are included.", "title": "Columns", "type": "object" } }, "required": [ "columns" ], "title": "ApiTableProfile", "type": "object" }, "AsyncDataSourceTestResults": { "properties": { "id": { "title": "Id", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/TestResultStep" }, "title": "Results", "type": "array" }, "status": { "$ref": "#/components/schemas/JobStatus" } }, "required": [ "id", "status", "results" ], "title": "AsyncDataSourceTestResults", "type": "object" }, "AuditLogs": { "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "client_ip": { "title": "Client Ip", "type": "string" }, "event_uuid": { "title": "Event Uuid", "type": "string" }, "is_support_user": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Support User" }, "log_entry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Log Entry" }, "object_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Object Id" }, "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Payload" }, "referer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referer" }, "request_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Type" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "timestamp": { "title": "Timestamp", "type": "string" }, "url": { "title": "Url", "type": "string" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "timestamp", "event_uuid", "client_ip", "url" ], "title": "AuditLogs", "type": "object" }, "AwsAthenaConfig": { "properties": { "aws_access_key_id": { "title": "Aws Access Key Id", "type": "string" }, "aws_secret_access_key": { "format": "password", "title": "Aws Secret Access Key", "type": "string", "writeOnly": true }, "catalog": { "default": "awsdatacatalog", "title": "Catalog", "type": "string" }, "database": { "default": "default", "title": "Database", "type": "string" }, "region": { "title": "Region", "type": "string" }, "s3_staging_dir": { "title": "S3 Staging Dir", "type": "string" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "s3_staging_dir", "region" ], "title": "AwsAthenaConfig", "type": "object" }, "AzureDataLakeConfig": { "properties": { "account_name": { "title": "Account Name", "type": "string" }, "client_id": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Client Secret" }, "materialize_max_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Materialize Max Rows" }, "materialize_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Materialize Path" }, "tenant_id": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "required": [ "account_name", "tenant_id", "client_id" ], "title": "AzureDataLakeConfig", "type": "object" }, "BaseTableMetricMonitorConfig": { "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter condition to evaluate.", "title": "Filter" }, "metric": { "anyOf": [ { "$ref": "#/components/schemas/TableMetricAlias" } ], "description": "The table metric configuration." }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the table.", "title": "Table" }, "type": { "const": "table", "default": "table", "title": "Type", "type": "string" } }, "required": [ "metric" ], "title": "Table", "type": "object" }, "BigQueryConfig": { "properties": { "extraProjectsToIndex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": [ "project1\nproject2" ], "section": "config", "title": "List of extra projects to index (one per line)", "widget": "multiline" }, "jsonKeyFile": { "format": "password", "section": "basic", "title": "JSON Key File", "type": "string", "writeOnly": true }, "jsonOAuthKeyFile": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "section": "basic", "title": "JSON OAuth Key File" }, "location": { "default": "US", "examples": [ "US" ], "section": "basic", "title": "Processing Location", "type": "string" }, "projectId": { "section": "basic", "title": "Project ID", "type": "string" }, "totalMBytesProcessedLimit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "section": "config", "title": "Scanned Data Limit (MB)" }, "useStandardSql": { "default": true, "section": "config", "title": "Use Standard SQL", "type": "boolean" }, "userDefinedFunctionResourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": [ "gs://bucket/date_utils.js" ], "section": "config", "title": "UDF Source URIs" } }, "required": [ "projectId", "jsonKeyFile" ], "title": "BigQueryConfig", "type": "object" }, "Body_toggle_monitor_on_off_api_v1_monitors__id__toggle_put": { "properties": { "enabled": { "description": "Indicate whether to enable or disable the monitor.", "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "Body_toggle_monitor_on_off_api_v1_monitors__id__toggle_put", "type": "object" }, "Body_update_datadiff_api_v1_datadiffs__datadiff_id__patch": { "properties": { "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived" }, "purged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Purged" } }, "title": "Body_update_datadiff_api_v1_datadiffs__datadiff_id__patch", "type": "object" }, "CSVFileOptions": { "properties": { "delimiter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delimiter" }, "file_type": { "const": "csv", "default": "csv", "title": "File Type", "type": "string" }, "skip_head_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Skip Head Rows" }, "skip_tail_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Skip Tail Rows" } }, "title": "CSVFileOptions", "type": "object" }, "CertCheck": { "enum": [ "disable", "dremio-cloud", "customcert" ], "title": "CertCheck", "type": "string" }, "CiDiff": { "properties": { "exclude_columns": { "default": [], "items": { "type": "string" }, "title": "Exclude Columns", "type": "array" }, "include_columns": { "default": [], "items": { "type": "string" }, "title": "Include Columns", "type": "array" }, "pk": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Pk" }, "pr": { "title": "Pr", "type": "string" }, "prod": { "title": "Prod", "type": "string" } }, "required": [ "prod", "pr" ], "title": "CiDiff", "type": "object" }, "Column": { "description": "Database table column.", "properties": { "name": { "title": "Name", "type": "string" }, "table": { "$ref": "#/components/schemas/TableReference" }, "type": { "const": "Column", "default": "Column", "title": "Type", "type": "string" } }, "required": [ "name", "table" ], "title": "Column", "type": "object" }, "ColumnMetric": { "enum": [ "total", "distinct", "uniqueness", "nulls", "fill_rate", "sum", "min", "max", "qmin", "qmax", "median", "average", "stddev", "col_freshness_minutes" ], "title": "ColumnMetric", "type": "string" }, "ColumnMetricAlias": { "enum": [ "minimum", "maximum", "std_dev", "cardinality", "uniqueness", "median", "average", "sum", "fill_rate" ], "title": "ColumnMetricAlias", "type": "string" }, "ColumnMetricMonitorConfig": { "properties": { "column": { "description": "The column of the table.", "title": "Column", "type": "string" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter condition to evaluate.", "title": "Filter" }, "metric": { "anyOf": [ { "$ref": "#/components/schemas/ColumnMetricAlias" } ], "description": "The column metric configuration.", "title": "Metric" }, "table": { "description": "The name of the table.", "title": "Table", "type": "string" }, "type": { "const": "column", "default": "column", "title": "Type", "type": "string" } }, "required": [ "table", "column", "metric" ], "title": "Column", "type": "object" }, "ColumnReference": { "description": "Database table column reference.", "properties": { "name": { "title": "Column name", "type": "string" } }, "required": [ "name" ], "title": "ColumnReference", "type": "object" }, "ColumnRule": { "properties": { "column": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Column name the rule applies to, matched case-insensitively. When column remapping is enabled, this refers to the dataset-A (canonical) column name \u2014 the same name the comparator operates on after remapping. A selector matching no compared column applies nothing and is logged as a warning. Mutually exclusive with `type`. Exactly one of `column` or `type` must be set.", "title": "Column" }, "equal_if": { "description": "SQL boolean expression OR-ed into the value comparator for the matching column(s). Use {a} and {b} as placeholders for the side-A and side-B column references. Multiple rules matching the same column are all OR-ed together. Example: \"{a} = '1900-01-01' AND {b} IS NULL\".", "title": "Equal If", "type": "string" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/DatatypeName" }, { "type": "null" } ], "description": "Type-based selector \u2014 matches all columns whose Datatype.typename equals this value, resolved against the types the comparison actually runs on (the source warehouse types for same-database diffs, the negotiated DuckDB types for cross-database diffs). Mutually exclusive with `column`. Exactly one of `column` or `type` must be set." } }, "required": [ "equal_if" ], "title": "ColumnRule", "type": "object" }, "ColumnTolerance": { "properties": { "column_name": { "description": "Column name to apply tolerance to.", "title": "Column Name", "type": "string" }, "tolerance_mode": { "$ref": "#/components/schemas/ToleranceModeEnum", "description": "'absolute' or 'relative'." }, "tolerance_value": { "description": "Tolerance value. Must be >= 0.", "title": "Tolerance Value", "type": "number" } }, "required": [ "column_name", "tolerance_value", "tolerance_mode" ], "title": "ColumnTolerance", "type": "object" }, "ColumnToleranceConfig": { "properties": { "column_tolerance": { "anyOf": [ { "additionalProperties": { "discriminator": { "mapping": { "absolute": "#/components/schemas/AbsoluteColumnTolerance", "relative": "#/components/schemas/RelativeColumnTolerance" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/RelativeColumnTolerance" }, { "$ref": "#/components/schemas/AbsoluteColumnTolerance" } ] }, "type": "object" }, { "type": "null" } ], "description": "Specific tolerance per column.", "title": "Column Tolerance" }, "default": { "anyOf": [ { "discriminator": { "mapping": { "absolute": "#/components/schemas/AbsoluteColumnTolerance", "relative": "#/components/schemas/RelativeColumnTolerance" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/RelativeColumnTolerance" }, { "$ref": "#/components/schemas/AbsoluteColumnTolerance" } ] }, { "type": "null" } ], "description": "Default tolerance applied to all columns.", "title": "Default" } }, "title": "ColumnToleranceConfig", "type": "object" }, "ConfigurationCheckStep": { "enum": [ "connection", "temp_schema", "schema_download", "lineage_download" ], "title": "ConfigurationCheckStep", "type": "string" }, "CronSchedule": { "properties": { "cron": { "description": "The cron expression that defines the schedule.", "title": "Cron", "type": "string" }, "type": { "const": "crontab", "default": "crontab", "title": "Type", "type": "string" } }, "required": [ "cron" ], "title": "Cron", "type": "object" }, "CustomMetricMonitorConfig": { "properties": { "alert_on_missing_data": { "default": false, "description": "Trigger alert if query returns unexpectedly few data points.", "title": "Alert On Missing Data", "type": "boolean" }, "query": { "description": "The SQL query to be evaluated.", "title": "Query", "type": "string" }, "type": { "const": "custom", "default": "custom", "title": "Type", "type": "string" } }, "required": [ "query" ], "title": "Custom", "type": "object" }, "DB2Config": { "description": "Configuration for IBM DB2 database connection.", "properties": { "connection_timeout": { "default": 30, "description": "Connection timeout in seconds", "title": "Connection Timeout", "type": "integer" }, "current_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Default schema to use (SET CURRENT SCHEMA)", "title": "Current Schema" }, "dbname": { "description": "Database name", "title": "Dbname", "type": "string" }, "host": { "description": "DB2 server hostname", "maxLength": 128, "title": "Host", "type": "string" }, "password": { "description": "Database password", "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "pool_size": { "default": 1, "description": "Number of connections in pool", "title": "Pool Size", "type": "integer" }, "port": { "default": 50000, "description": "DB2 server port", "title": "Port", "type": "integer" }, "ssl": { "default": false, "description": "Enable SSL connection", "title": "Ssl", "type": "boolean" }, "ssl_certificate": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "description": "SSL server certificate (PEM format or file path)", "title": "Ssl Certificate" }, "user": { "description": "Database username", "title": "User", "type": "string" } }, "required": [ "host", "dbname", "user", "password" ], "title": "DB2Config", "type": "object" }, "DataDiffMonitorSpecPublic": { "properties": { "alert": { "anyOf": [ { "$ref": "#/components/schemas/datafold__monitors__schemas__DiffAlertCondition" }, { "type": "null" } ], "description": "Condition for triggering alerts based on the data diff." }, "datadiff": { "description": "Configuration for the data diff.", "discriminator": { "mapping": { "indb": "#/components/schemas/InDbDataDiffConfig", "inmem": "#/components/schemas/InMemDataDiffConfig" }, "propertyName": "diff_type" }, "oneOf": [ { "$ref": "#/components/schemas/InDbDataDiffConfig" }, { "$ref": "#/components/schemas/InMemDataDiffConfig" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "enabled": { "default": true, "description": "Indicates whether the monitor is enabled.", "title": "Enabled", "type": "boolean" }, "name": { "description": "The name of the monitor.", "title": "Name", "type": "string" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Replaced on every provision: omitting this key clears the monitor's owner.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. Replaces the monitor's whole tag set on every provision: omitting this key (or passing an empty list) removes all of the monitor's existing tags.", "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "schedule", "name", "datadiff" ], "title": "DataDiffMonitorSpecPublic", "type": "object" }, "DataDiffToleranceConfig": { "properties": { "datetime": { "anyOf": [ { "$ref": "#/components/schemas/DatetimeColumnToleranceConfig" }, { "type": "null" } ], "description": "Configuration for datetime columns tolerance." }, "float": { "anyOf": [ { "$ref": "#/components/schemas/ColumnToleranceConfig" }, { "type": "null" } ], "description": "Configuration for float columns tolerance." } }, "title": "DataDiffToleranceConfig", "type": "object" }, "DataDiffUpdateMonitorSpecPublic": { "properties": { "alert": { "anyOf": [ { "$ref": "#/components/schemas/datafold__monitors__schemas__DiffAlertCondition" }, { "type": "null" } ], "description": "Condition for triggering alerts based on the data diff." }, "datadiff": { "anyOf": [ { "discriminator": { "mapping": { "indb": "#/components/schemas/InDbUpdateDataDiffConfig", "inmem": "#/components/schemas/InMemUpdateDataDiffConfig" }, "propertyName": "diff_type" }, "oneOf": [ { "$ref": "#/components/schemas/InDbUpdateDataDiffConfig" }, { "$ref": "#/components/schemas/InMemUpdateDataDiffConfig" } ] }, { "type": "null" } ], "description": "Configuration for the data diff." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the monitor.", "title": "Name" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Omitting this key leaves the current owner alone; an explicit null clears it.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" }, { "type": "null" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. A non-empty list replaces the monitor's whole tag set; an empty list (or an omitted key) leaves the existing tags alone, so tags cannot be cleared through this endpoint.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "type": { "const": "diff", "description": "The type of monitor.", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Diff", "type": "object" }, "DataSourceBinding": { "properties": { "boundIds": { "items": { "type": "integer" }, "title": "Boundids", "type": "array" }, "remoteId": { "title": "Remoteid", "type": "string" } }, "required": [ "remoteId", "boundIds" ], "title": "DataSourceBinding", "type": "object" }, "DataTestMonitorSpecPublic": { "properties": { "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "enabled": { "default": true, "description": "Indicates whether the monitor is enabled.", "title": "Enabled", "type": "boolean" }, "name": { "description": "The name of the monitor.", "title": "Name", "type": "string" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Replaced on every provision: omitting this key clears the monitor's owner.", "title": "Owner" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The SQL query to be evaluated.", "title": "Query" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. Replaces the monitor's whole tag set on every provision: omitting this key (or passing an empty list) removes all of the monitor's existing tags.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "test": { "anyOf": [ { "$ref": "#/components/schemas/StandardDataTestMonitorSpec" }, { "type": "null" } ] } }, "required": [ "schedule", "name", "connection_id" ], "title": "DataTestMonitorSpecPublic", "type": "object" }, "DataTestUpdateMonitorSpecPublic": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the monitor.", "title": "Name" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Omitting this key leaves the current owner alone; an explicit null clears it.", "title": "Owner" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The SQL query to be evaluated.", "title": "Query" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" }, { "type": "null" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. A non-empty list replaces the monitor's whole tag set; an empty list (or an omitted key) leaves the existing tags alone, so tags cannot be cleared through this endpoint.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "test": { "anyOf": [ { "$ref": "#/components/schemas/StandardDataTestMonitorSpec" }, { "type": "null" } ] }, "type": { "const": "test", "description": "The type of monitor.", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Data", "type": "object" }, "DatabricksConfig": { "properties": { "auth_method": { "anyOf": [ { "enum": [ "pat", "m2m_oauth", "azure_entra" ], "type": "string" }, { "type": "null" } ], "title": "Auth Method" }, "azure_client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azure Client Id" }, "azure_client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Azure Client Secret" }, "azure_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azure Scope" }, "azure_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azure Tenant Id" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Database" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "http_password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Access Token" }, "http_path": { "default": "", "title": "HTTP Path", "type": "string" }, "m2m_client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "M2M Client Id" }, "m2m_client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Client Secret" }, "oauth_dwh_client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth Dwh Client Id" }, "oauth_dwh_client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Oauth Dwh Client Secret" } }, "required": [ "host" ], "title": "DatabricksConfig", "type": "object" }, "DatatypeName": { "enum": [ "boolean", "integer", "float", "decimal", "unbounded_decimal", "money", "string", "fixed_length_string", "varbinary", "binary", "date", "super", "time", "time_interval", "timestamp", "year", "uuid", "array", "struct", "json", "xml", "map", "void", "unsupported" ], "title": "DatatypeName", "type": "string" }, "DatetimeColumnToleranceConfig": { "properties": { "default": { "enum": [ "1s", "0.1s", "0.01s", "1ms", "0.1ms", "0.01ms", "1us" ], "title": "Default", "type": "string" } }, "required": [ "default" ], "title": "DatetimeColumnToleranceConfig", "type": "object" }, "DayIntervalSchedule": { "properties": { "every": { "const": "day", "title": "Every", "type": "string" }, "hour": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The hour at which the monitor should trigger. (0 - 23)", "title": "Hour" }, "type": { "const": "daily", "default": "daily", "title": "Type", "type": "string" }, "utc_at": { "anyOf": [ { "format": "time", "type": "string" }, { "type": "null" } ], "description": "The UTC time at which the monitor should trigger.", "title": "Utc At" } }, "required": [ "every" ], "title": "Day", "type": "object" }, "DbtDataSourceConfig": { "properties": { "ci_config_id": { "title": "Ci Config Id", "type": "integer" }, "indexing_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Indexing Cron" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "ci_config_id" ], "title": "DbtDataSourceConfig", "type": "object" }, "DestinationFeatures": { "enum": [ "attach_csv", "notify_first_triggered_only", "disable_recovery_notifications", "notify_every_run" ], "title": "DestinationFeatures", "type": "string" }, "DiffAlgorithm": { "enum": [ "join", "hash", "hash_v2_alpha", "fetch_and_join" ], "title": "DiffAlgorithm", "type": "string" }, "DiffKind": { "enum": [ "in_db", "cross_db" ], "title": "DiffKind", "type": "string" }, "DiffProgress": { "properties": { "completed_steps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completed Steps" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "total_steps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Steps" }, "version": { "title": "Version", "type": "string" } }, "required": [ "version" ], "title": "DiffProgress", "type": "object" }, "DiffStats": { "properties": { "diff_duplicate_pks": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diff Duplicate Pks" }, "diff_null_pks": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diff Null Pks" }, "diff_pks": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diff Pks" }, "diff_rows": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diff Rows" }, "diff_rows_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Diff Rows Count" }, "diff_rows_number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diff Rows Number" }, "diff_schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Share of columns that differ between the two schemas. Reported for same-database diffs only \u2014 cross-database diffs always carry 0 here, which means \"not measured\", not \"no schema drift\". To inspect a cross-database schema comparison, use the MCP tools `get_datadiff_overview` (its `schema` section) or `get_datadiff_result_section` with section=\"columns\".", "title": "Diff Schema" }, "diff_values": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diff Values" }, "errors": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Errors" }, "match_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Match Ratio" }, "rows_added": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rows Added" }, "rows_removed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rows Removed" }, "sampled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sampled" }, "table_a_row_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Table A Row Count" }, "table_b_row_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Table B Row Count" }, "version": { "title": "Version", "type": "string" } }, "required": [ "version" ], "title": "DiffStats", "type": "object" }, "DremioConfig": { "properties": { "certcheck": { "anyOf": [ { "$ref": "#/components/schemas/CertCheck" }, { "type": "null" } ], "default": "dremio-cloud", "title": "Certificate check" }, "customcert": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Custom certificate" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 443, "title": "Port", "type": "integer" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role (case sensitive)" }, "tls": { "default": false, "title": "Encryption", "type": "boolean" }, "token": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Token" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User ID (optional)" }, "view_temp_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temporary schema for views" } }, "required": [ "host" ], "title": "DremioConfig", "type": "object" }, "DuckDBConfig": { "properties": {}, "title": "DuckDBConfig", "type": "object" }, "EmailNotification": { "properties": { "features": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DestinationFeatures" }, "type": "array" }, { "type": "null" } ], "description": "A list of features to enable for this notification.", "title": "Features" }, "recipients": { "description": "A list of email addresses to receive the notification.", "items": { "type": "string" }, "title": "Recipients", "type": "array" }, "type": { "const": "email", "default": "email", "title": "Type", "type": "string" } }, "required": [ "recipients" ], "title": "Email", "type": "object" }, "ExcelFileOptions": { "properties": { "file_type": { "const": "excel", "default": "excel", "title": "File Type", "type": "string" }, "sheet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sheet" }, "skip_head_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Skip Head Rows" }, "skip_tail_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Skip Tail Rows" } }, "title": "ExcelFileOptions", "type": "object" }, "GCSConfig": { "properties": { "bucket_name": { "title": "Bucket Name", "type": "string" }, "bucket_region": { "title": "Bucket Region", "type": "string" }, "jsonKeyFile": { "format": "password", "section": "basic", "title": "JSON Key File", "type": "string", "writeOnly": true }, "materialize_max_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Materialize Max Rows" }, "materialize_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Materialize Path" } }, "required": [ "bucket_name", "jsonKeyFile", "bucket_region" ], "title": "GCSConfig", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HighTouchDataSourceConfig": { "properties": { "bindings": { "items": { "$ref": "#/components/schemas/DataSourceBinding" }, "title": "Bindings", "type": "array" }, "indexing_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Indexing Cron" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "token": { "format": "password", "title": "Token", "type": "string", "writeOnly": true }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace" } }, "required": [ "token", "bindings" ], "title": "HighTouchDataSourceConfig", "type": "object" }, "HourIntervalSchedule": { "properties": { "every": { "const": "hour", "title": "Every", "type": "string" }, "type": { "const": "hourly", "default": "hourly", "title": "Type", "type": "string" } }, "required": [ "every" ], "title": "Hour", "type": "object" }, "InDbDataDiffConfig": { "properties": { "column_remapping": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Mapping of columns from one dataset to another for comparison.", "title": "Column Remapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. `equal_if` is raw SQL run verbatim in the source warehouse for in-database diffs, so write it in that warehouse's dialect. See `ColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Optional list of columns to compare between the datasets.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "dataset_a": { "anyOf": [ { "$ref": "#/components/schemas/InDbTableDataset" }, { "$ref": "#/components/schemas/InDbQueryDataset" } ], "description": "The first dataset to compare." }, "dataset_b": { "anyOf": [ { "$ref": "#/components/schemas/InDbTableDataset" }, { "$ref": "#/components/schemas/InDbQueryDataset" } ], "description": "The second dataset to compare." }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior (so an empty-vs-empty diff keeps its raw match_ratio metric at 0.0). Enable this to stop a match_ratio_min alert from firing when both tables are empty.", "title": "Empty Tables Match" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to exclude from the comparison. InDb diffs accept gitignore-style patterns (e.g. '*_ts'); InMem diffs require exact column names. Primary-key columns are never excluded.", "title": "Exclude Columns" }, "ignore_string_case": { "default": false, "description": "Indicates whether to ignore case differences in string comparisons.", "title": "Ignore String Case", "type": "boolean" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to include in the comparison. InDb diffs accept gitignore-style patterns (e.g. '*_ts'); InMem diffs require exact column names. Alias of columns_to_compare; set only one.", "title": "Include Columns" }, "materialize_results": { "default": false, "description": "Indicates whether to materialize the results of the comparison.", "title": "Materialize Results", "type": "boolean" }, "null_equals_empty_string": { "default": false, "description": "Treat NULL and empty string ('') as equal in string comparisons and PK joins.", "title": "Null Equals Empty String", "type": "boolean" }, "primary_key": { "description": "List of columns that make up the primary key for the datasets.", "items": { "type": "string" }, "title": "Primary Key", "type": "array" }, "sampling": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceBasedSampling" }, { "$ref": "#/components/schemas/PercentageSampling" }, { "$ref": "#/components/schemas/MaxRowsSampling" }, { "type": "null" } ], "description": "Sampling configuration for the data comparison." }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "timeseries_dimension_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Column used for time series dimensioning in the comparison.", "title": "Timeseries Dimension Column" }, "tolerance": { "anyOf": [ { "$ref": "#/components/schemas/DataDiffToleranceConfig" }, { "type": "null" } ], "description": "Configuration for tolerance." } }, "required": [ "primary_key", "dataset_a", "dataset_b" ], "title": "In-Database", "type": "object" }, "InDbQueryDataset": { "properties": { "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "query": { "description": "The SQL query to be evaluated.", "title": "Query", "type": "string" }, "session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Parameters for the database session.", "title": "Session Parameters" }, "time_travel_point": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "description": "Point in time for querying historical data.", "title": "Time Travel Point" } }, "required": [ "connection_id", "query" ], "title": "Query", "type": "object" }, "InDbTableDataset": { "properties": { "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter condition for querying the dataset.", "title": "Filter" }, "session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Session parameters for the database session.", "title": "Session Parameters" }, "table": { "description": "The table in the format 'db.schema.table'.", "title": "Table", "type": "string" }, "time_travel_point": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "description": "Point in time for querying historical data.", "title": "Time Travel Point" } }, "required": [ "connection_id", "table" ], "title": "Table", "type": "object" }, "InDbUpdateDataDiffConfig": { "properties": { "column_remapping": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Mapping of columns from one dataset to another for comparison.", "title": "Column Remapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. `equal_if` is raw SQL run verbatim in the source warehouse for in-database diffs, so write it in that warehouse's dialect. See `ColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Optional list of columns to compare between the datasets.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior (so an empty-vs-empty diff keeps its raw match_ratio metric at 0.0). Enable this to stop a match_ratio_min alert from firing when both tables are empty.", "title": "Empty Tables Match" }, "ignore_string_case": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Indicates whether to ignore case differences in string comparisons.", "title": "Ignore String Case" }, "materialize_results": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Indicates whether to materialize the results of the comparison.", "title": "Materialize Results" }, "null_equals_empty_string": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Treat NULL and empty string ('') as equal in string comparisons and PK joins.", "title": "Null Equals Empty String" }, "primary_key": { "description": "List of columns that make up the primary key for the datasets.", "items": { "type": "string" }, "title": "Primary Key", "type": "array" }, "sampling": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceBasedSampling" }, { "$ref": "#/components/schemas/PercentageSampling" }, { "$ref": "#/components/schemas/MaxRowsSampling" }, { "type": "null" } ], "description": "Sampling configuration for the data comparison." }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "timeseries_dimension_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Column used for time series dimensioning in the comparison.", "title": "Timeseries Dimension Column" }, "tolerance": { "anyOf": [ { "$ref": "#/components/schemas/DataDiffToleranceConfig" }, { "type": "null" } ], "description": "Configuration for tolerance applied to FLOAT columns." } }, "title": "In-Database", "type": "object" }, "InMemDataDiffConfig": { "properties": { "column_remapping": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Mapping of columns from one dataset to another for comparison.", "title": "Column Remapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. `equal_if` is raw SQL run verbatim in the local DuckDB both sides are fetched into \u2014 not in either source warehouse \u2014 so write it in DuckDB's dialect. See `ColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Optional list of columns to compare between the datasets.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "dataset_a": { "anyOf": [ { "$ref": "#/components/schemas/XdbTableDataset" }, { "$ref": "#/components/schemas/XdbQueryDataset" } ], "description": "The first dataset to compare.", "title": "Dataset A" }, "dataset_b": { "anyOf": [ { "$ref": "#/components/schemas/XdbTableDataset" }, { "$ref": "#/components/schemas/XdbQueryDataset" } ], "description": "The second dataset to compare.", "title": "Dataset B" }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior (so an empty-vs-empty diff keeps its raw match_ratio metric at 0.0). Enable this to stop a match_ratio_min alert from firing when both tables are empty.", "title": "Empty Tables Match" }, "exclude_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to exclude from the comparison. InDb diffs accept gitignore-style patterns (e.g. '*_ts'); InMem diffs require exact column names. Primary-key columns are never excluded.", "title": "Exclude Columns" }, "ignore_string_case": { "default": false, "description": "Indicates whether to ignore case differences in string comparisons.", "title": "Ignore String Case", "type": "boolean" }, "include_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Columns to include in the comparison. InDb diffs accept gitignore-style patterns (e.g. '*_ts'); InMem diffs require exact column names. Alias of columns_to_compare; set only one.", "title": "Include Columns" }, "materialize_results": { "default": false, "description": "Indicates whether to materialize the results of the comparison.", "title": "Materialize Results", "type": "boolean" }, "materialize_results_to": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Identifier for the destination where results should be materialized.", "title": "Materialize Results To" }, "null_equals_empty_string": { "default": false, "description": "Treat NULL and empty string ('') as equal in string comparisons and PK joins.", "title": "Null Equals Empty String", "type": "boolean" }, "primary_key": { "description": "List of columns that make up the primary key for the datasets.", "items": { "type": "string" }, "title": "Primary Key", "type": "array" }, "sampling": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceBasedSampling" }, { "$ref": "#/components/schemas/PercentageSampling" }, { "$ref": "#/components/schemas/MaxRowsSampling" }, { "type": "null" } ], "description": "Sampling configuration for the data comparison.", "title": "Sampling" }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "tolerance": { "anyOf": [ { "$ref": "#/components/schemas/DataDiffToleranceConfig" }, { "type": "null" } ], "description": "Configuration for tolerance." } }, "required": [ "primary_key", "dataset_a", "dataset_b" ], "title": "In-Memory", "type": "object" }, "InMemUpdateDataDiffConfig": { "properties": { "column_remapping": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Mapping of columns from one dataset to another for comparison.", "title": "Column Remapping" }, "column_rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ColumnRule" }, "type": "array" }, { "type": "null" } ], "description": "Extra equality clauses that extend the diff value comparator. Useful for treating specific value pairs (e.g. legacy sentinels vs NULL) as non-differences. `equal_if` is raw SQL run verbatim in the local DuckDB both sides are fetched into \u2014 not in either source warehouse \u2014 so write it in DuckDB's dialect. See `ColumnRule` for entry shape.", "title": "Column Rules" }, "columns_to_compare": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Optional list of columns to compare between the datasets.", "title": "Columns To Compare" }, "compare_duplicates": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Compare rows with duplicate primary keys. Defaults to true.", "title": "Compare Duplicates" }, "empty_tables_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When both datasets are empty (0 rows on each side), report a match ratio of 100% instead of 0%. Defaults to false, preserving the historical 0% behavior (so an empty-vs-empty diff keeps its raw match_ratio metric at 0.0). Enable this to stop a match_ratio_min alert from firing when both tables are empty.", "title": "Empty Tables Match" }, "ignore_string_case": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Indicates whether to ignore case differences in string comparisons.", "title": "Ignore String Case" }, "materialize_results": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Indicates whether to materialize the results of the comparison.", "title": "Materialize Results" }, "materialize_results_to": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Identifier for the destination where results should be materialized.", "title": "Materialize Results To" }, "null_equals_empty_string": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Treat NULL and empty string ('') as equal in string comparisons and PK joins.", "title": "Null Equals Empty String" }, "primary_key": { "description": "List of columns that make up the primary key for the datasets.", "items": { "type": "string" }, "title": "Primary Key", "type": "array" }, "sampling": { "anyOf": [ { "$ref": "#/components/schemas/ToleranceBasedSampling" }, { "$ref": "#/components/schemas/PercentageSampling" }, { "$ref": "#/components/schemas/MaxRowsSampling" }, { "type": "null" } ], "description": "Sampling configuration for the data comparison.", "title": "Sampling" }, "sort_array_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Sort array elements before comparison to ignore insertion order differences.", "title": "Sort Array Columns" }, "tolerance": { "anyOf": [ { "$ref": "#/components/schemas/DataDiffToleranceConfig" }, { "type": "null" } ], "description": "Configuration for tolerance." } }, "title": "In-Memory", "type": "object" }, "InternalApiDataDiffDependencies": { "properties": { "dependencies": { "items": { "$ref": "#/components/schemas/ApiCIDependency" }, "title": "Dependencies", "type": "array" }, "status": { "enum": [ "done", "success" ], "title": "Status", "type": "string" } }, "required": [ "status", "dependencies" ], "title": "InternalApiDataDiffDependencies", "type": "object" }, "IntervalSchedule": { "properties": { "interval": { "anyOf": [ { "$ref": "#/components/schemas/HourIntervalSchedule" }, { "$ref": "#/components/schemas/DayIntervalSchedule" } ], "description": "Specifies the scheduling interval." } }, "required": [ "interval" ], "title": "Interval", "type": "object" }, "JobSource": { "enum": [ "interactive", "demo_signup", "manual", "api", "ci", "schedule", "auto" ], "title": "JobSource", "type": "string" }, "JobStatus": { "enum": [ "needs_confirmation", "needs_authentication", "waiting", "queued", "processing", "done", "failed", "cancelled" ], "title": "JobStatus", "type": "string" }, "LookerDataSourceConfig": { "properties": { "base_url": { "title": "Base Url", "type": "string" }, "bindings": { "default": [], "items": { "$ref": "#/components/schemas/DataSourceBinding" }, "title": "Bindings", "type": "array" }, "client_id": { "title": "Client Id", "type": "string" }, "client_secret": { "format": "password", "title": "Client Secret", "type": "string", "writeOnly": true }, "indexing_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Indexing Cron" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "project_ids": { "default": [], "items": { "type": "string" }, "title": "Project Ids", "type": "array" }, "repo_id": { "title": "Repo Id", "type": "integer" } }, "required": [ "base_url", "client_id", "repo_id", "client_secret" ], "title": "LookerDataSourceConfig", "type": "object" }, "MSSQLConfig": { "properties": { "always_on": { "default": false, "title": "Always On", "type": "boolean" }, "dbname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dbname" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 1433, "title": "Port", "type": "integer" }, "require_encryption": { "default": true, "title": "Require Encryption", "type": "boolean" }, "session_script": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ...", "title": "Init script" }, "trust_server_certificate": { "default": true, "title": "Trust Server Certificate", "type": "boolean" }, "user": { "default": "DATAFOLD", "title": "User", "type": "string" } }, "required": [ "host" ], "title": "MSSQLConfig", "type": "object" }, "MariaDBConfig": { "description": "Configuration for MariaDB connections.\n\nMariaDB is MySQL-compatible, so we reuse the MySQL configuration.\nDefault port is 3306, same as MySQL.", "properties": { "db": { "title": "Database name", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "port": { "default": 3306, "title": "Port", "type": "integer" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "password", "db" ], "title": "MariaDBConfig", "type": "object" }, "MaxRowsSampling": { "properties": { "max_rows": { "description": "The maximum number of rows to sample.", "title": "Max Rows", "type": "integer" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for triggering actions based on sampling.", "title": "Threshold" } }, "required": [ "max_rows" ], "title": "MaxRows", "type": "object" }, "MetricMonitorSpecPublic": { "properties": { "alert": { "anyOf": [ { "discriminator": { "mapping": { "absolute": "#/components/schemas/AbsoluteThreshold", "automatic": "#/components/schemas/AnomalyDetectionThreshold", "percentage": "#/components/schemas/PercentageThreshold" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnomalyDetectionThreshold" }, { "$ref": "#/components/schemas/AbsoluteThreshold" }, { "$ref": "#/components/schemas/PercentageThreshold" } ] }, { "type": "null" } ], "description": "Condition for triggering alerts." }, "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "enabled": { "default": true, "description": "Indicates whether the monitor is enabled.", "title": "Enabled", "type": "boolean" }, "metric": { "description": "Configuration for the metric being monitored.", "discriminator": { "mapping": { "column": "#/components/schemas/ColumnMetricMonitorConfig", "custom": "#/components/schemas/CustomMetricMonitorConfig", "table": "#/components/schemas/BaseTableMetricMonitorConfig" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/BaseTableMetricMonitorConfig" }, { "$ref": "#/components/schemas/ColumnMetricMonitorConfig" }, { "$ref": "#/components/schemas/CustomMetricMonitorConfig" } ] }, "name": { "description": "The name of the monitor.", "title": "Name", "type": "string" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Replaced on every provision: omitting this key clears the monitor's owner.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. Replaces the monitor's whole tag set on every provision: omitting this key (or passing an empty list) removes all of the monitor's existing tags.", "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "schedule", "name", "connection_id", "metric" ], "title": "MetricMonitorSpecPublic", "type": "object" }, "MetricUpdateMonitorSpecPublic": { "properties": { "alert": { "anyOf": [ { "discriminator": { "mapping": { "absolute": "#/components/schemas/AbsoluteThreshold", "automatic": "#/components/schemas/AnomalyDetectionThreshold", "percentage": "#/components/schemas/PercentageThreshold" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnomalyDetectionThreshold" }, { "$ref": "#/components/schemas/AbsoluteThreshold" }, { "$ref": "#/components/schemas/PercentageThreshold" } ] }, { "type": "null" } ], "description": "Condition for triggering alerts." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the monitor.", "title": "Name" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Omitting this key leaves the current owner alone; an explicit null clears it.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" }, { "type": "null" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. A non-empty list replaces the monitor's whole tag set; an empty list (or an omitted key) leaves the existing tags alone, so tags cannot be cleared through this endpoint.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "type": { "const": "metric", "description": "The type of monitor.", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Metric", "type": "object" }, "MicrosoftFabricConfig": { "properties": { "client_id": { "description": "Microsoft Entra ID Application (Client) ID", "title": "Application (Client) ID", "type": "string" }, "client_secret": { "description": "Microsoft Entra ID Application Client Secret", "format": "password", "title": "Client Secret", "type": "string", "writeOnly": true }, "dbname": { "title": "Dbname", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "session_script": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ...", "title": "Init script" }, "tenant_id": { "description": "Microsoft Entra ID Tenant ID", "title": "Tenant ID", "type": "string" } }, "required": [ "host", "dbname", "tenant_id", "client_id", "client_secret" ], "title": "MicrosoftFabricConfig", "type": "object" }, "ModeDataSourceConfig": { "properties": { "indexing_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Indexing Cron" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "password": { "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "token": { "format": "password", "title": "Token", "type": "string", "writeOnly": true }, "workspace": { "default": "", "title": "Workspace", "type": "string" } }, "required": [ "token", "password" ], "title": "ModeDataSourceConfig", "type": "object" }, "MongoDBConfig": { "properties": { "auth_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "admin", "title": "Auth Source" }, "connect_timeout_ms": { "default": 60000, "title": "Connect Timeout Ms", "type": "integer" }, "database": { "title": "Database", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "port": { "default": 27017, "title": "Port", "type": "integer" }, "server_selection_timeout_ms": { "default": 60000, "title": "Server Selection Timeout Ms", "type": "integer" }, "socket_timeout_ms": { "default": 300000, "title": "Socket Timeout Ms", "type": "integer" }, "username": { "title": "Username", "type": "string" } }, "required": [ "database", "username", "password", "host" ], "title": "MongoDBConfig", "type": "object" }, "MonitorDataset": { "properties": { "column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The column of the table.", "title": "Column" }, "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter condition being evaluated.", "title": "Filter" }, "metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The column metric configuration.", "title": "Metric" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The SQL query being evaluated.", "title": "Query" }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the table.", "title": "Table" } }, "required": [ "connection_id" ], "title": "MonitorDataset", "type": "object" }, "MonitorRunState": { "enum": [ "ok", "alert", "error", "learning", "checking", "created", "skipped", "cancelled", "queued" ], "title": "MonitorRunState", "type": "string" }, "MySQLConfig": { "properties": { "db": { "title": "Database name", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "port": { "default": 3306, "title": "Port", "type": "integer" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "password", "db" ], "title": "MySQLConfig", "type": "object" }, "NetezzaConfig": { "properties": { "database": { "maxLength": 128, "title": "Database", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 5480, "title": "Port", "type": "integer" }, "tls": { "default": true, "title": "Encryption", "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User ID (optional)" } }, "required": [ "host", "database" ], "title": "NetezzaConfig", "type": "object" }, "NoneSchedule": { "properties": { "type": { "const": "none", "default": "none", "title": "Type", "type": "string" } }, "title": "None", "type": "object" }, "OracleConfig": { "properties": { "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Database" }, "database_type": { "anyOf": [ { "enum": [ "service", "sid" ], "type": "string" }, { "type": "null" } ], "title": "Database Type" }, "ewallet_password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "EWallet password" }, "ewallet_pem_file": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "EWallet PEM" }, "ewallet_pkcs12_file": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "EWallet PKCS12" }, "ewallet_type": { "anyOf": [ { "enum": [ "x509", "pkcs12" ], "type": "string" }, { "type": "null" } ], "title": "Ewallet Type" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Port" }, "session_script": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ...", "title": "Init script" }, "ssl": { "default": false, "title": "Ssl", "type": "boolean" }, "ssl_server_dn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "e.g. C=US,O=example,CN=db.example.com; default: CN=", "title": "Server's SSL DN" }, "user": { "default": "DATAFOLD", "title": "User", "type": "string" } }, "required": [ "host" ], "title": "OracleConfig", "type": "object" }, "PagerDutyNotification": { "properties": { "features": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DestinationFeatures" }, "type": "array" }, { "type": "null" } ], "description": "A list of features to enable for this notification.", "title": "Features" }, "integration": { "description": "The identifier for the integration.", "title": "Integration", "type": "integer" }, "type": { "const": "pagerduty", "default": "pagerduty", "title": "Type", "type": "string" } }, "required": [ "integration" ], "title": "PagerDuty", "type": "object" }, "ParquetFileOptions": { "properties": { "file_type": { "const": "parquet", "default": "parquet", "title": "File Type", "type": "string" } }, "title": "ParquetFileOptions", "type": "object" }, "PercentageSampling": { "properties": { "rate": { "description": "The sampling rate as a percentage.", "title": "Rate", "type": "number" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for triggering actions based on sampling.", "title": "Threshold" } }, "required": [ "rate" ], "title": "Percentage", "type": "object" }, "PercentageThreshold": { "properties": { "decrease": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "Threshold for allowable percentage decrease.", "title": "Decrease" }, "increase": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "Threshold for allowable percentage increase.", "title": "Increase" }, "type": { "const": "percentage", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Percentage", "type": "object" }, "PostgreSQLAuroraConfig": { "properties": { "aws_access_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "AWS Access Key" }, "aws_cloudwatch_log_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cloudwatch Postgres Log Group" }, "aws_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "AWS Region" }, "aws_secret_access_key": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "AWS Secret" }, "dbname": { "title": "Database Name", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "keep_alive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Keep Alive timeout in seconds, leave empty to disable" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 5432, "title": "Port", "type": "integer" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role (case sensitive)" }, "rootcert": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Root certificate" }, "sslmode": { "$ref": "#/components/schemas/SslMode", "default": "prefer", "title": "SSL Mode" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "dbname" ], "title": "PostgreSQLAuroraConfig", "type": "object" }, "PostgreSQLConfig": { "properties": { "dbname": { "title": "Database Name", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 5432, "title": "Port", "type": "integer" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role (case sensitive)" }, "rootcert": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Root certificate" }, "sslmode": { "$ref": "#/components/schemas/SslMode", "default": "prefer", "title": "SSL Mode" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "dbname" ], "title": "PostgreSQLConfig", "type": "object" }, "PowerBIAuthType": { "enum": [ "delegated", "service_principal" ], "title": "PowerBIAuthType", "type": "string" }, "PowerBIDataSourceConfig": { "description": "Power BI data source parameters.", "properties": { "auth_type": { "anyOf": [ { "$ref": "#/components/schemas/PowerBIAuthType" }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Client Secret" }, "indexing_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Indexing Cron" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "title": "PowerBIDataSourceConfig", "type": "object" }, "QueryError": { "properties": { "error_type": { "title": "Error Type", "type": "string" }, "error_value": { "title": "Error Value", "type": "string" } }, "required": [ "error_type", "error_value" ], "title": "QueryError", "type": "object" }, "RedshiftConfig": { "properties": { "adhoc_query_group": { "default": "default", "section": "config", "title": "Query Group for Adhoc Queries", "type": "string" }, "dbname": { "title": "Database Name", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 5432, "title": "Port", "type": "integer" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role (case sensitive)" }, "rootcert": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Root certificate" }, "scheduled_query_group": { "default": "default", "section": "config", "title": "Query Group for Scheduled Queries", "type": "string" }, "sslmode": { "$ref": "#/components/schemas/SslMode", "default": "prefer", "title": "SSL Mode" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "dbname" ], "title": "RedshiftConfig", "type": "object" }, "RelativeColumnTolerance": { "properties": { "type": { "const": "relative", "default": "relative", "description": "The type of Column Tolerance.", "title": "Type", "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "description": "Value of Column Tolerance.", "title": "Value" } }, "required": [ "value" ], "title": "Relative", "type": "object" }, "SDTTable": { "properties": { "columns": { "items": { "type": "string" }, "title": "Columns", "type": "array" }, "path": { "title": "Path", "type": "string" } }, "required": [ "path", "columns" ], "title": "SDTTable", "type": "object" }, "SDTVariable": { "properties": { "quote": { "default": true, "title": "Quote", "type": "boolean" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "type": "integer" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "type": "array" } ], "title": "Value" } }, "required": [ "value" ], "title": "SDTVariable", "type": "object" }, "SSLVerification": { "enum": [ "full", "none", "ca" ], "title": "SSLVerification", "type": "string" }, "SapHanaConfig": { "properties": { "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "port": { "default": 443, "title": "Port", "type": "integer" }, "user": { "default": "DATAFOLD", "title": "User", "type": "string" } }, "required": [ "host", "password" ], "title": "SapHanaConfig", "type": "object" }, "SchemaChangeMonitorSpecPublic": { "properties": { "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "enabled": { "default": true, "description": "Indicates whether the monitor is enabled.", "title": "Enabled", "type": "boolean" }, "name": { "description": "The name of the monitor.", "title": "Name", "type": "string" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Replaced on every provision: omitting this key clears the monitor's owner.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" } ], "description": "The schedule at which the monitor runs." }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the table.", "title": "Table" }, "tags": { "description": "Tags associated with the monitor. Replaces the monitor's whole tag set on every provision: omitting this key (or passing an empty list) removes all of the monitor's existing tags.", "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "schedule", "name", "connection_id" ], "title": "SchemaChangeMonitorSpecPublic", "type": "object" }, "SchemaChangeUpdateMonitorSpecPublic": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the monitor.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the monitor.", "title": "Name" }, "notifications": { "description": "Notification configuration for the monitor.", "items": { "discriminator": { "mapping": { "email": "#/components/schemas/EmailNotification", "pagerduty": "#/components/schemas/PagerDutyNotification", "slack": "#/components/schemas/SlackNotification", "teams": "#/components/schemas/TeamsNotification", "webhook": "#/components/schemas/WebhookNotification" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/EmailNotification" }, { "$ref": "#/components/schemas/PagerDutyNotification" }, { "$ref": "#/components/schemas/WebhookNotification" }, { "$ref": "#/components/schemas/SlackNotification" }, { "$ref": "#/components/schemas/TeamsNotification" } ] }, "title": "Notifications", "type": "array" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email of the monitor owner. Omitting this key leaves the current owner alone; an explicit null clears it.", "title": "Owner" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/IntervalSchedule" }, { "$ref": "#/components/schemas/CronSchedule" }, { "$ref": "#/components/schemas/NoneSchedule" }, { "type": "null" } ], "description": "The schedule at which the monitor runs." }, "tags": { "description": "Tags associated with the monitor. A non-empty list replaces the monitor's whole tag set; an empty list (or an omitted key) leaves the existing tags alone, so tags cannot be cleared through this endpoint.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "type": { "const": "schema", "description": "The type of monitor.", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Schema", "type": "object" }, "SlackNotification": { "properties": { "channel": { "description": "The channel through which the notification will be sent.", "title": "Channel", "type": "string" }, "features": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DestinationFeatures" }, "type": "array" }, { "type": "null" } ], "description": "A list of features to enable for this notification.", "title": "Features" }, "integration": { "description": "The identifier for the integration.", "title": "Integration", "type": "integer" }, "mentions": { "description": "A list of mentions to include in the notification.", "items": { "type": "string" }, "title": "Mentions", "type": "array" }, "type": { "const": "slack", "default": "slack", "title": "Type", "type": "string" } }, "required": [ "integration", "channel" ], "title": "Slack", "type": "object" }, "SnowflakeConfig": { "properties": { "account": { "maxLength": 128, "title": "Account", "type": "string" }, "authMethod": { "anyOf": [ { "enum": [ "password", "keypair", "azure_entra" ], "type": "string" }, { "type": "null" } ], "title": "Authmethod" }, "azure_client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azure Client Id" }, "azure_client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Azure Client Secret" }, "azure_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azure Scope" }, "azure_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azure Tenant Id" }, "data_source_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data Source Id" }, "default_db": { "default": "", "examples": [ "MY_DB" ], "title": "Default DB (case sensitive)", "type": "string" }, "default_schema": { "default": "PUBLIC", "examples": [ "PUBLIC" ], "section": "config", "title": "Default schema (case sensitive)", "type": "string" }, "keyPairFile": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Key Pair file (private-key)" }, "metadata_database": { "default": "SNOWFLAKE", "examples": [ "SNOWFLAKE" ], "section": "config", "title": "Database containing metadata (usually SNOWFLAKE)", "type": "string" }, "oauth_dwh_client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth Dwh Client Id" }, "oauth_dwh_client_secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Oauth Dwh Client Secret" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 443, "title": "Port" }, "quoted_identifiers_ignore_case": { "default": false, "section": "config", "title": "Set QUOTED_IDENTIFIERS_IGNORE_CASE session parameter", "type": "boolean" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "section": "config", "title": "Region" }, "role": { "default": "", "examples": [ "PUBLIC" ], "title": "Role (case sensitive)", "type": "string" }, "sql_variables": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": [ "variable_1=10\nvariable_2=test" ], "section": "config", "title": "Session variables applied at every connection.", "widget": "multiline" }, "user": { "default": "DATAFOLD", "title": "User", "type": "string" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id" }, "warehouse": { "default": "", "examples": [ "COMPUTE_WH" ], "title": "Warehouse (case sensitive)", "type": "string" } }, "required": [ "account" ], "title": "SnowflakeConfig", "type": "object" }, "SortableFields": { "enum": [ "id", "name", "last_triggered", "last_run", "created_by" ], "title": "SortableFields", "type": "string" }, "SslMode": { "description": "SSL mode for database connections (used by PostgreSQL, Vertica, Redshift, etc.)", "enum": [ "prefer", "require", "verify-ca", "verify-full" ], "title": "SslMode", "type": "string" }, "StandardDataTestMonitorSpec": { "properties": { "tables": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SDTTable" }, "type": "array" }, { "type": "null" } ], "title": "Tables" }, "type": { "$ref": "#/components/schemas/StandardDataTestTypes" }, "variables": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/SDTVariable" }, "type": "object" }, { "type": "null" } ], "title": "Variables" } }, "required": [ "type" ], "title": "Standard DT", "type": "object" }, "StandardDataTestTypes": { "enum": [ "unique", "not_null", "accepted_values", "referential_integrity", "numeric_range", "custom_template" ], "title": "StandardDataTestTypes", "type": "string" }, "StarburstConfig": { "properties": { "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 443, "title": "Port", "type": "integer" }, "tls": { "default": true, "title": "Encryption", "type": "boolean" }, "token": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Token" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User ID (optional)" } }, "required": [ "host" ], "title": "StarburstConfig", "type": "object" }, "SubmitCiJob": { "properties": { "ci_run_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ci Run Id" }, "run_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Run Id" } }, "title": "SubmitCiJob", "type": "object" }, "TDataDiffDataAppMetadata": { "properties": { "data_app_id": { "title": "Data App Id", "type": "integer" }, "data_app_model1_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data App Model1 Id" }, "data_app_model1_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data App Model1 Name" }, "data_app_model2_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data App Model2 Id" }, "data_app_model2_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data App Model2 Name" }, "data_app_model_type": { "title": "Data App Model Type", "type": "string" }, "meta_data": { "additionalProperties": true, "title": "Meta Data", "type": "object" } }, "required": [ "data_app_id", "data_app_model_type", "meta_data" ], "title": "TDataDiffDataAppMetadata", "type": "object" }, "Table": { "description": "Database table.", "properties": { "columns": { "items": { "$ref": "#/components/schemas/ColumnReference" }, "title": "Columns", "type": "array" }, "name": { "title": "Name", "type": "string" }, "path": { "items": { "type": "string" }, "title": "Table path", "type": "array" }, "type": { "const": "Table", "default": "Table", "title": "Type", "type": "string" } }, "required": [ "name", "columns", "path" ], "title": "Table", "type": "object" }, "TableMetric": { "enum": [ "total", "distinct", "column_count", "freshness_seconds", "freshness_minutes", "col_freshness_minutes" ], "title": "TableMetric", "type": "string" }, "TableMetricAlias": { "enum": [ "row_count", "freshness" ], "title": "TableMetricAlias", "type": "string" }, "TableModifiers": { "enum": [ "case_insensitive_strings", "null_equals_empty_string" ], "title": "TableModifiers", "type": "string" }, "TableReference": { "description": "Database table reference.", "properties": { "name": { "title": "Table name", "type": "string" }, "path": { "items": { "type": "string" }, "title": "Table path", "type": "array" } }, "required": [ "name", "path" ], "title": "TableReference", "type": "object" }, "TableauDataSourceConfig": { "properties": { "indexing_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Indexing Cron" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "server_url": { "title": "Server Url", "type": "string" }, "site_id": { "title": "Site Id", "type": "string" }, "token_name": { "title": "Token Name", "type": "string" }, "token_value": { "format": "password", "title": "Token Value", "type": "string", "writeOnly": true } }, "required": [ "token_name", "token_value", "site_id", "server_url" ], "title": "TableauDataSourceConfig", "type": "object" }, "TeamsNotification": { "properties": { "channel": { "description": "The channel through which the notification will be sent.", "title": "Channel", "type": "string" }, "features": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DestinationFeatures" }, "type": "array" }, { "type": "null" } ], "description": "A list of features to enable for this notification.", "title": "Features" }, "integration": { "description": "The identifier for the integration.", "title": "Integration", "type": "integer" }, "mentions": { "description": "A list of mentions names to include in the notification.", "items": { "type": "string" }, "title": "Mentions", "type": "array" }, "type": { "const": "teams", "default": "teams", "title": "Type", "type": "string" } }, "required": [ "integration", "channel" ], "title": "Teams", "type": "object" }, "TeradataConfig": { "properties": { "database": { "title": "Database", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "format": "password", "title": "Password", "type": "string", "writeOnly": true }, "port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Port" }, "tmode": { "default": "ANSI", "enum": [ "ANSI", "TERA" ], "title": "Tmode", "type": "string" }, "user": { "default": "DATAFOLD", "title": "User", "type": "string" } }, "required": [ "host", "password", "database" ], "title": "TeradataConfig", "type": "object" }, "TestDataSourceAsyncResponse": { "properties": { "job_id": { "title": "Job Id", "type": "integer" } }, "required": [ "job_id" ], "title": "TestDataSourceAsyncResponse", "type": "object" }, "TestResultStep": { "properties": { "result": { "anyOf": [ {}, { "type": "null" } ], "title": "Result" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "step": { "$ref": "#/components/schemas/ConfigurationCheckStep" } }, "required": [ "step", "status" ], "title": "TestResultStep", "type": "object" }, "TimeAggregateEnum": { "enum": [ "minute", "hour", "day", "week", "month", "year" ], "title": "TimeAggregateEnum", "type": "string" }, "ToleranceBasedSampling": { "properties": { "confidence": { "description": "The confidence level for the sampling results.", "title": "Confidence", "type": "number" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for triggering actions based on sampling.", "title": "Threshold" }, "tolerance": { "description": "The allowable margin of error for sampling.", "title": "Tolerance", "type": "number" } }, "required": [ "tolerance", "confidence" ], "title": "Tolerance", "type": "object" }, "ToleranceModeEnum": { "enum": [ "absolute", "relative" ], "title": "ToleranceModeEnum", "type": "string" }, "TrinoConfig": { "properties": { "dbname": { "title": "Catalog Name", "type": "string" }, "hive_timestamp_precision": { "anyOf": [ { "enum": [ 3, 6, 9 ], "type": "integer" }, { "type": "null" } ], "description": "Optional: Timestamp precision if using Hive connector", "title": "Hive Timestamp Precision" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 8080, "title": "Port", "type": "integer" }, "ssl_verification": { "$ref": "#/components/schemas/SSLVerification", "default": "full", "title": "SSL Verification" }, "tls": { "default": true, "title": "Encryption", "type": "boolean" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "dbname" ], "title": "TrinoConfig", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "VerticaConfig": { "properties": { "dbname": { "title": "Database Name", "type": "string" }, "host": { "maxLength": 128, "title": "Host", "type": "string" }, "password": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "port": { "default": 5433, "title": "Port", "type": "integer" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role (case sensitive)" }, "sslmode": { "$ref": "#/components/schemas/SslMode", "default": "prefer", "title": "SSL Mode" }, "user": { "title": "User", "type": "string" } }, "required": [ "host", "user", "dbname" ], "title": "VerticaConfig", "type": "object" }, "WebhookNotification": { "properties": { "features": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DestinationFeatures" }, "type": "array" }, { "type": "null" } ], "description": "A list of features to enable for this notification.", "title": "Features" }, "integration": { "description": "The identifier for the integration.", "title": "Integration", "type": "integer" }, "type": { "const": "webhook", "default": "webhook", "title": "Type", "type": "string" } }, "required": [ "integration" ], "title": "Webhook", "type": "object" }, "XdbQueryDataset": { "properties": { "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "materialize": { "default": true, "description": "Indicates whether to materialize the dataset.", "title": "Materialize", "type": "boolean" }, "query": { "description": "The SQL query to be evaluated.", "title": "Query", "type": "string" }, "session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Parameters for the database session.", "title": "Session Parameters" } }, "required": [ "connection_id", "query" ], "title": "Query", "type": "object" }, "XdbTableDataset": { "properties": { "connection_id": { "description": "The identifier for the data source configuration.", "title": "Connection Id", "type": "integer" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter condition for querying the dataset.", "title": "Filter" }, "materialize": { "default": true, "description": "Indicates whether to materialize the dataset.", "title": "Materialize", "type": "boolean" }, "session_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Session parameters for the database session.", "title": "Session Parameters" }, "table": { "description": "The table in the format 'db.schema.table'.", "title": "Table", "type": "string" } }, "required": [ "connection_id", "table" ], "title": "Table", "type": "object" }, "datafold__api__v1__monitors__DiffAlertCondition": { "properties": { "different_rows_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for the number of different rows allowed between the datasets.", "title": "Different Rows Count" }, "different_rows_percent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for the percentage of different rows allowed between the datasets.", "title": "Different Rows Percent" }, "match_ratio_min": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Minimum acceptable match ratio (0.0-1.0). Alert when match_ratio < match_ratio_min.", "title": "Match Ratio Min" }, "type": { "const": "diff", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Diff Conditions", "type": "object" }, "datafold__monitors__schemas__DiffAlertCondition": { "properties": { "different_rows_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for the number of different rows allowed between the datasets.", "title": "Different Rows Count" }, "different_rows_percent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Threshold for the percentage of different rows allowed between the datasets.", "title": "Different Rows Percent" }, "match_ratio_min": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Minimum acceptable match ratio (0.0-1.0). Alert when match_ratio < match_ratio_min.", "title": "Match Ratio Min" } }, "title": "Diff Conditions", "type": "object" } }, "securitySchemes": { "ApiKeyAuth": { "description": "Use the 'Authorization' header with the format 'Key '", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "contact": { "email": "support@datafold.com", "name": "API Support" }, "description": "The Datafold API reference is a guide to our available endpoints and authentication methods.\nIf you're just getting started with Datafold, we recommend first checking out our [documentation](https://docs.datafold.com).\n\n:::info\n To use the Datafold API, you should first create a Datafold API Key,\n which should be stored as a local environment variable named DATAFOLD_API_KEY.\n This can be set in your Datafold Cloud's Settings under the Account page.\n:::", "title": "Datafold API", "version": "latest" }, "openapi": "3.1.0", "paths": { "/api/v1/audit_logs": { "get": { "operationId": "get_audit_logs_api_v1_audit_logs_get", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiDownloadAuditLogs" }, { "type": "null" } ], "title": "Data" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiGetAuditLogs" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Audit Logs", "tags": [ "Audit Logs" ] } }, "/api/v1/ci/{ci_config_id}/runs": { "get": { "operationId": "get_ci_api_v1_ci__ci_config_id__runs_get", "parameters": [ { "in": "path", "name": "ci_config_id", "required": true, "schema": { "title": "CI config id", "type": "integer" } }, { "in": "query", "name": "pr_sha", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pr Sha" } }, { "in": "query", "name": "pr_num", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pr Num" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiCiRun" }, "title": "Response Get Ci Api V1 Ci Ci Config Id Runs Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List CI runs", "tags": [ "CI" ] } }, "/api/v1/ci/{ci_config_id}/trigger": { "post": { "operationId": "trigger_ci_api_v1_ci__ci_config_id__trigger_post", "parameters": [ { "in": "path", "name": "ci_config_id", "required": true, "schema": { "title": "CI config id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPrDetails" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitCiJob" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Trigger a PR/MR run", "tags": [ "CI" ] } }, "/api/v1/ci/{ci_config_id}/{pr_num}": { "post": { "operationId": "upload_changes_api_v1_ci__ci_config_id___pr_num__post", "parameters": [ { "in": "path", "name": "ci_config_id", "required": true, "schema": { "title": "CI config id", "type": "integer" } }, { "in": "path", "name": "pr_num", "required": true, "schema": { "title": "Pull request/Merge request number", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CiDiff" }, "title": "Diffs", "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitCiJob" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Upload PR/MR changes", "tags": [ "CI" ] } }, "/api/v1/data_sources": { "get": { "description": "Retrieves all data sources for the organization, annotated with an `accessible` boolean.\n\nReturns active data sources (not deleted, hidden, or draft). Each DS includes `accessible=True`\nif the user is admin or the user's groups overlap with the DS's groups.", "operationId": "list_data_sources_api_v1_data_sources_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "discriminator": { "mapping": { "athena": "#/components/schemas/ApiDataSourceAwsAthena", "aws_s3": "#/components/schemas/ApiDataSourceS3", "azure_synapse": "#/components/schemas/ApiDataSourceAzureSynapse", "bigquery": "#/components/schemas/ApiDataSourceBigQuery", "databricks": "#/components/schemas/ApiDataSourceDatabricks", "db2": "#/components/schemas/ApiDataSourceDB2", "dremio": "#/components/schemas/ApiDataSourceDremio", "duckdb": "#/components/schemas/ApiDataSourceDuckDB", "files_azure_datalake": "#/components/schemas/ApiDataSourceAzureDataLake", "google_cloud_storage": "#/components/schemas/ApiDataSourceGCS", "mariadb": "#/components/schemas/ApiDataSourceMariaDB", "microsoft_fabric": "#/components/schemas/ApiDataSourceMicrosoftFabric", "mongodb": "#/components/schemas/ApiDataSourceMongoDB", "mssql": "#/components/schemas/ApiDataSourceMSSQL", "mysql": "#/components/schemas/ApiDataSourceMySQL", "netezza": "#/components/schemas/ApiDataSourceNetezza", "oracle": "#/components/schemas/ApiDataSourceOracle", "pg": "#/components/schemas/ApiDataSourcePostgres", "postgres_aurora": "#/components/schemas/ApiDataSourcePostgresAurora", "postgres_aws_rds": "#/components/schemas/ApiDataSourcePostgresRds", "redshift": "#/components/schemas/ApiDataSourceRedshift", "sap_hana": "#/components/schemas/ApiDataSourceSapHana", "snowflake": "#/components/schemas/ApiDataSourceSnowflake", "starburst": "#/components/schemas/ApiDataSourceStarburst", "teradata": "#/components/schemas/ApiDataSourceTeradata", "trino": "#/components/schemas/ApiDataSourceTrino", "vertica": "#/components/schemas/ApiDataSourceVertica" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ApiDataSourceBigQuery" }, { "$ref": "#/components/schemas/ApiDataSourceDatabricks" }, { "$ref": "#/components/schemas/ApiDataSourceDuckDB" }, { "$ref": "#/components/schemas/ApiDataSourceMongoDB" }, { "$ref": "#/components/schemas/ApiDataSourceMySQL" }, { "$ref": "#/components/schemas/ApiDataSourceMariaDB" }, { "$ref": "#/components/schemas/ApiDataSourceMSSQL" }, { "$ref": "#/components/schemas/ApiDataSourceOracle" }, { "$ref": "#/components/schemas/ApiDataSourcePostgres" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresAurora" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresRds" }, { "$ref": "#/components/schemas/ApiDataSourceRedshift" }, { "$ref": "#/components/schemas/ApiDataSourceTeradata" }, { "$ref": "#/components/schemas/ApiDataSourceSapHana" }, { "$ref": "#/components/schemas/ApiDataSourceDB2" }, { "$ref": "#/components/schemas/ApiDataSourceAwsAthena" }, { "$ref": "#/components/schemas/ApiDataSourceSnowflake" }, { "$ref": "#/components/schemas/ApiDataSourceDremio" }, { "$ref": "#/components/schemas/ApiDataSourceStarburst" }, { "$ref": "#/components/schemas/ApiDataSourceNetezza" }, { "$ref": "#/components/schemas/ApiDataSourceAzureDataLake" }, { "$ref": "#/components/schemas/ApiDataSourceGCS" }, { "$ref": "#/components/schemas/ApiDataSourceS3" }, { "$ref": "#/components/schemas/ApiDataSourceAzureSynapse" }, { "$ref": "#/components/schemas/ApiDataSourceMicrosoftFabric" }, { "$ref": "#/components/schemas/ApiDataSourceVertica" }, { "$ref": "#/components/schemas/ApiDataSourceTrino" } ] }, "title": "Response List Data Sources Api V1 Data Sources Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List data sources", "tags": [ "Data sources" ] }, "post": { "operationId": "create_new_datasource_api_v1_data_sources_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDataSourceForm" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "athena": "#/components/schemas/ApiDataSourceAwsAthena", "aws_s3": "#/components/schemas/ApiDataSourceS3", "azure_synapse": "#/components/schemas/ApiDataSourceAzureSynapse", "bigquery": "#/components/schemas/ApiDataSourceBigQuery", "databricks": "#/components/schemas/ApiDataSourceDatabricks", "db2": "#/components/schemas/ApiDataSourceDB2", "dremio": "#/components/schemas/ApiDataSourceDremio", "duckdb": "#/components/schemas/ApiDataSourceDuckDB", "files_azure_datalake": "#/components/schemas/ApiDataSourceAzureDataLake", "google_cloud_storage": "#/components/schemas/ApiDataSourceGCS", "mariadb": "#/components/schemas/ApiDataSourceMariaDB", "microsoft_fabric": "#/components/schemas/ApiDataSourceMicrosoftFabric", "mongodb": "#/components/schemas/ApiDataSourceMongoDB", "mssql": "#/components/schemas/ApiDataSourceMSSQL", "mysql": "#/components/schemas/ApiDataSourceMySQL", "netezza": "#/components/schemas/ApiDataSourceNetezza", "oracle": "#/components/schemas/ApiDataSourceOracle", "pg": "#/components/schemas/ApiDataSourcePostgres", "postgres_aurora": "#/components/schemas/ApiDataSourcePostgresAurora", "postgres_aws_rds": "#/components/schemas/ApiDataSourcePostgresRds", "redshift": "#/components/schemas/ApiDataSourceRedshift", "sap_hana": "#/components/schemas/ApiDataSourceSapHana", "snowflake": "#/components/schemas/ApiDataSourceSnowflake", "starburst": "#/components/schemas/ApiDataSourceStarburst", "teradata": "#/components/schemas/ApiDataSourceTeradata", "trino": "#/components/schemas/ApiDataSourceTrino", "vertica": "#/components/schemas/ApiDataSourceVertica" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ApiDataSourceBigQuery" }, { "$ref": "#/components/schemas/ApiDataSourceDatabricks" }, { "$ref": "#/components/schemas/ApiDataSourceDuckDB" }, { "$ref": "#/components/schemas/ApiDataSourceMongoDB" }, { "$ref": "#/components/schemas/ApiDataSourceMySQL" }, { "$ref": "#/components/schemas/ApiDataSourceMariaDB" }, { "$ref": "#/components/schemas/ApiDataSourceMSSQL" }, { "$ref": "#/components/schemas/ApiDataSourceOracle" }, { "$ref": "#/components/schemas/ApiDataSourcePostgres" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresAurora" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresRds" }, { "$ref": "#/components/schemas/ApiDataSourceRedshift" }, { "$ref": "#/components/schemas/ApiDataSourceTeradata" }, { "$ref": "#/components/schemas/ApiDataSourceSapHana" }, { "$ref": "#/components/schemas/ApiDataSourceDB2" }, { "$ref": "#/components/schemas/ApiDataSourceAwsAthena" }, { "$ref": "#/components/schemas/ApiDataSourceSnowflake" }, { "$ref": "#/components/schemas/ApiDataSourceDremio" }, { "$ref": "#/components/schemas/ApiDataSourceStarburst" }, { "$ref": "#/components/schemas/ApiDataSourceNetezza" }, { "$ref": "#/components/schemas/ApiDataSourceAzureDataLake" }, { "$ref": "#/components/schemas/ApiDataSourceGCS" }, { "$ref": "#/components/schemas/ApiDataSourceS3" }, { "$ref": "#/components/schemas/ApiDataSourceAzureSynapse" }, { "$ref": "#/components/schemas/ApiDataSourceMicrosoftFabric" }, { "$ref": "#/components/schemas/ApiDataSourceVertica" }, { "$ref": "#/components/schemas/ApiDataSourceTrino" } ], "title": "Response Create New Datasource Api V1 Data Sources Post" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a data source", "tags": [ "Data sources", "data_source_added" ] } }, "/api/v1/data_sources/test/{job_id}": { "get": { "operationId": "get_data_source_test_result_api_v1_data_sources_test__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Data source testing task id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncDataSourceTestResults" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get data source testing results", "tags": [ "Data sources" ] } }, "/api/v1/data_sources/types": { "get": { "operationId": "get_data_source_types_api_v1_data_sources_types_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiDataSourceType" }, "title": "Response Get Data Source Types Api V1 Data Sources Types Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List data source types", "tags": [ "Data sources" ] } }, "/api/v1/data_sources/{data_source_id}": { "get": { "operationId": "get_data_source_api_v1_data_sources__data_source_id__get", "parameters": [ { "in": "path", "name": "data_source_id", "required": true, "schema": { "title": "Data source id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "athena": "#/components/schemas/ApiDataSourceAwsAthena", "aws_s3": "#/components/schemas/ApiDataSourceS3", "azure_synapse": "#/components/schemas/ApiDataSourceAzureSynapse", "bigquery": "#/components/schemas/ApiDataSourceBigQuery", "databricks": "#/components/schemas/ApiDataSourceDatabricks", "db2": "#/components/schemas/ApiDataSourceDB2", "dremio": "#/components/schemas/ApiDataSourceDremio", "duckdb": "#/components/schemas/ApiDataSourceDuckDB", "files_azure_datalake": "#/components/schemas/ApiDataSourceAzureDataLake", "google_cloud_storage": "#/components/schemas/ApiDataSourceGCS", "mariadb": "#/components/schemas/ApiDataSourceMariaDB", "microsoft_fabric": "#/components/schemas/ApiDataSourceMicrosoftFabric", "mongodb": "#/components/schemas/ApiDataSourceMongoDB", "mssql": "#/components/schemas/ApiDataSourceMSSQL", "mysql": "#/components/schemas/ApiDataSourceMySQL", "netezza": "#/components/schemas/ApiDataSourceNetezza", "oracle": "#/components/schemas/ApiDataSourceOracle", "pg": "#/components/schemas/ApiDataSourcePostgres", "postgres_aurora": "#/components/schemas/ApiDataSourcePostgresAurora", "postgres_aws_rds": "#/components/schemas/ApiDataSourcePostgresRds", "redshift": "#/components/schemas/ApiDataSourceRedshift", "sap_hana": "#/components/schemas/ApiDataSourceSapHana", "snowflake": "#/components/schemas/ApiDataSourceSnowflake", "starburst": "#/components/schemas/ApiDataSourceStarburst", "teradata": "#/components/schemas/ApiDataSourceTeradata", "trino": "#/components/schemas/ApiDataSourceTrino", "vertica": "#/components/schemas/ApiDataSourceVertica" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ApiDataSourceBigQuery" }, { "$ref": "#/components/schemas/ApiDataSourceDatabricks" }, { "$ref": "#/components/schemas/ApiDataSourceDuckDB" }, { "$ref": "#/components/schemas/ApiDataSourceMongoDB" }, { "$ref": "#/components/schemas/ApiDataSourceMySQL" }, { "$ref": "#/components/schemas/ApiDataSourceMariaDB" }, { "$ref": "#/components/schemas/ApiDataSourceMSSQL" }, { "$ref": "#/components/schemas/ApiDataSourceOracle" }, { "$ref": "#/components/schemas/ApiDataSourcePostgres" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresAurora" }, { "$ref": "#/components/schemas/ApiDataSourcePostgresRds" }, { "$ref": "#/components/schemas/ApiDataSourceRedshift" }, { "$ref": "#/components/schemas/ApiDataSourceTeradata" }, { "$ref": "#/components/schemas/ApiDataSourceSapHana" }, { "$ref": "#/components/schemas/ApiDataSourceDB2" }, { "$ref": "#/components/schemas/ApiDataSourceAwsAthena" }, { "$ref": "#/components/schemas/ApiDataSourceSnowflake" }, { "$ref": "#/components/schemas/ApiDataSourceDremio" }, { "$ref": "#/components/schemas/ApiDataSourceStarburst" }, { "$ref": "#/components/schemas/ApiDataSourceNetezza" }, { "$ref": "#/components/schemas/ApiDataSourceAzureDataLake" }, { "$ref": "#/components/schemas/ApiDataSourceGCS" }, { "$ref": "#/components/schemas/ApiDataSourceS3" }, { "$ref": "#/components/schemas/ApiDataSourceAzureSynapse" }, { "$ref": "#/components/schemas/ApiDataSourceMicrosoftFabric" }, { "$ref": "#/components/schemas/ApiDataSourceVertica" }, { "$ref": "#/components/schemas/ApiDataSourceTrino" } ], "title": "Response Get Data Source Api V1 Data Sources Data Source Id Get" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get a data source", "tags": [ "Data sources" ] } }, "/api/v1/data_sources/{data_source_id}/query": { "post": { "description": "Executes a SQL query against the specified data source and returns the results.\n\nThis endpoint allows you to run ad-hoc SQL queries for data exploration, validation, or analysis.\nThe query is executed using the data source's native query runner with the appropriate credentials.\n\n**Streaming mode**: Use query parameter `?stream=true` or set `X-Stream-Response: true` header.\nStreaming is only supported for certain data sources (e.g., Databricks).\nWhen streaming, results are sent incrementally as valid JSON for memory efficiency.\n\nReturns:\n- Query results as rows with column metadata (name, type, description)\n- Limited to a reasonable number of rows for performance", "operationId": "execute_query_api_v1_data_sources__data_source_id__query_post", "parameters": [ { "in": "path", "name": "data_source_id", "required": true, "schema": { "title": "Data source ID", "type": "integer" } }, { "description": "Stream results as JSON", "in": "query", "name": "stream", "required": false, "schema": { "default": false, "description": "Stream results as JSON", "title": "Stream", "type": "boolean" } }, { "in": "header", "name": "X-Stream-Response", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Stream-Response" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiQueryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiQueryResult" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Execute a SQL query against a data source", "tags": [ "Data sources" ] } }, "/api/v1/data_sources/{data_source_id}/summary": { "get": { "operationId": "get_data_source_summary_api_v1_data_sources__data_source_id__summary_get", "parameters": [ { "in": "path", "name": "data_source_id", "required": true, "schema": { "title": "Data source id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDataSourceSummary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get a data source summary", "tags": [ "Data sources" ] } }, "/api/v1/data_sources/{data_source_id}/test": { "post": { "operationId": "test_data_source_api_v1_data_sources__data_source_id__test_post", "parameters": [ { "in": "path", "name": "data_source_id", "required": true, "schema": { "title": "Data source id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestDataSourceAsyncResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Test a data source connection", "tags": [ "Data sources" ] } }, "/api/v1/datadiffs": { "get": { "description": "All fields support multiple items, using just comma delimiter\nDate fields also support ranges using the following syntax:\n\n- ``DATETIME`` = after DATETIME\n- ``DATETIME`` = between DATETIME and DATETIME + 1 MINUTE\n- ``DATE`` = start of that DATE until DATE + 1 DAY\n- ``DATETIME1< Integrations > Data Connections.", "in": "path", "name": "data_connection_id", "required": true, "schema": { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "minimum": 1, "title": "Data Connection ID", "type": "integer" } }, { "description": "Path to the column, e.g. `db.schema.table.column`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.my_schema.\"www.mysite.com visits\".\"visit.id\"`.", "in": "path", "name": "column_path", "required": true, "schema": { "description": "Path to the column, e.g. `db.schema.table.column`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.my_schema.\"www.mysite.com visits\".\"visit.id\"`.", "title": "Table Column Path", "type": "string" } }, { "description": "Maximum depth of the lineage to retrieve.", "in": "query", "name": "max_depth", "required": false, "schema": { "default": 10, "description": "Maximum depth of the lineage to retrieve.", "exclusiveMaximum": 100, "minimum": 1, "title": "Max depth", "type": "integer" } }, { "description": "Include Tables in the lineage calculation and in the output.", "in": "query", "name": "include_tabular_nodes", "required": false, "schema": { "default": true, "description": "Include Tables in the lineage calculation and in the output.", "title": "Include tabular nodes", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Column" }, { "$ref": "#/components/schemas/Table" } ] }, "title": "Response Db Column Downstreams Api V1 Explore Db Data Connection Id Columns Column Path Downstreams Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get column downstreams", "tags": [ "Explore" ] } }, "/api/v1/explore/db/{data_connection_id}/columns/{column_path}/upstreams": { "get": { "description": "Retrieve a list of columns or tables which the given column depends on.", "operationId": "db_column_upstreams_api_v1_explore_db__data_connection_id__columns__column_path__upstreams_get", "parameters": [ { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "in": "path", "name": "data_connection_id", "required": true, "schema": { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "minimum": 1, "title": "Data Connection ID", "type": "integer" } }, { "description": "Path to the column, e.g. `db.schema.table.column`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.my_schema.\"www.mysite.com visits\".\"visit.id\"`.", "in": "path", "name": "column_path", "required": true, "schema": { "description": "Path to the column, e.g. `db.schema.table.column`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.my_schema.\"www.mysite.com visits\".\"visit.id\"`.", "title": "Table Column Path", "type": "string" } }, { "description": "Maximum depth of the lineage to retrieve.", "in": "query", "name": "max_depth", "required": false, "schema": { "default": 10, "description": "Maximum depth of the lineage to retrieve.", "exclusiveMaximum": 100, "minimum": 1, "title": "Max depth", "type": "integer" } }, { "description": "Include Tables in the lineage calculation and in the output.", "in": "query", "name": "include_tabular_nodes", "required": false, "schema": { "default": true, "description": "Include Tables in the lineage calculation and in the output.", "title": "Include tabular nodes", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Column" }, { "$ref": "#/components/schemas/Table" } ] }, "title": "Response Db Column Upstreams Api V1 Explore Db Data Connection Id Columns Column Path Upstreams Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get column upstreams", "tags": [ "Explore" ] } }, "/api/v1/explore/db/{data_connection_id}/tables/{table_path}/downstreams": { "get": { "description": "Retrieve a list of tables which depend on the given table.", "operationId": "db_table_downstreams_api_v1_explore_db__data_connection_id__tables__table_path__downstreams_get", "parameters": [ { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "in": "path", "name": "data_connection_id", "required": true, "schema": { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "minimum": 1, "title": "Data Connection ID", "type": "integer" } }, { "description": "Path to the table, e.g. `db.schema.table`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.\"my.schema\".\"www.mysite.com visits\"`.", "in": "path", "name": "table_path", "required": true, "schema": { "description": "Path to the table, e.g. `db.schema.table`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.\"my.schema\".\"www.mysite.com visits\"`.", "title": "Table Path", "type": "string" } }, { "description": "Maximum depth of the lineage to retrieve.", "in": "query", "name": "max_depth", "required": false, "schema": { "default": 10, "description": "Maximum depth of the lineage to retrieve.", "exclusiveMaximum": 100, "minimum": 1, "title": "Max depth", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Table" }, "title": "Response Db Table Downstreams Api V1 Explore Db Data Connection Id Tables Table Path Downstreams Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get table downstreams", "tags": [ "Explore" ] } }, "/api/v1/explore/db/{data_connection_id}/tables/{table_path}/upstreams": { "get": { "description": "Retrieve a list of tables which the given table depends on.", "operationId": "db_table_upstreams_api_v1_explore_db__data_connection_id__tables__table_path__upstreams_get", "parameters": [ { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "in": "path", "name": "data_connection_id", "required": true, "schema": { "description": "Unique ID for the Data Connection. Can be found in the Datafold app under Settings > Integrations > Data Connections.", "minimum": 1, "title": "Data Connection ID", "type": "integer" } }, { "description": "Path to the table, e.g. `db.schema.table`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.\"my.schema\".\"www.mysite.com visits\"`.", "in": "path", "name": "table_path", "required": true, "schema": { "description": "Path to the table, e.g. `db.schema.table`. The path is case sensitive. If components of the path contain periods, they must be quoted: `db.\"my.schema\".\"www.mysite.com visits\"`.", "title": "Table Path", "type": "string" } }, { "description": "Maximum depth of the lineage to retrieve.", "in": "query", "name": "max_depth", "required": false, "schema": { "default": 10, "description": "Maximum depth of the lineage to retrieve.", "exclusiveMaximum": 100, "minimum": 1, "title": "Max depth", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Table" }, "title": "Response Db Table Upstreams Api V1 Explore Db Data Connection Id Tables Table Path Upstreams Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get table upstreams", "tags": [ "Explore" ] } }, "/api/v1/lineage/bi/": { "get": { "description": "Return all integrations for Mode/Tableau/Looker", "operationId": "get_all_integrations_api_v1_lineage_bi__get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "List all integrations", "tags": [ "BI" ] } }, "/api/v1/lineage/bi/dbt/": { "post": { "operationId": "create_dbt_integration_api_v1_lineage_bi_dbt__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DbtDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a DBT BI integration", "tags": [ "BI", "bi_added" ] } }, "/api/v1/lineage/bi/dbt/{bi_datasource_id}/": { "put": { "description": "Returns the integration with changed fields.", "operationId": "update_dbt_integration_api_v1_lineage_bi_dbt__bi_datasource_id___put", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "Tableau integration id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DbtDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a DBT BI integration", "tags": [ "BI", "bi_modified" ] } }, "/api/v1/lineage/bi/hightouch/": { "post": { "operationId": "create_hightouch_integration_api_v1_lineage_bi_hightouch__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HighTouchDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Hightouch integration", "tags": [ "BI", "bi_added" ] } }, "/api/v1/lineage/bi/hightouch/{bi_datasource_id}/": { "put": { "description": "It can only update the schedule. Returns the integration with changed fields.", "operationId": "change_hightouch_integration_api_v1_lineage_bi_hightouch__bi_datasource_id___put", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "Hightouch integration id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HighTouchDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a Hightouch integration", "tags": [ "BI", "bi_modified" ] } }, "/api/v1/lineage/bi/looker/": { "post": { "operationId": "create_looker_integration_api_v1_lineage_bi_looker__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookerDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Looker integration", "tags": [ "BI", "bi_added" ] } }, "/api/v1/lineage/bi/looker/{bi_datasource_id}/": { "put": { "description": "It can only update the schedule. Returns the integration with changed fields.", "operationId": "update_looker_integration_api_v1_lineage_bi_looker__bi_datasource_id___put", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "Looker integration id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookerDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a Looker integration", "tags": [ "BI", "bi_modified" ] } }, "/api/v1/lineage/bi/mode/": { "post": { "operationId": "create_mode_integration_api_v1_lineage_bi_mode__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModeDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Mode Analytics integration", "tags": [ "BI", "bi_added" ] } }, "/api/v1/lineage/bi/mode/{bi_datasource_id}/": { "put": { "description": "It can only update the schedule. Returns the integration with changed fields.", "operationId": "change_mode_integration_api_v1_lineage_bi_mode__bi_datasource_id___put", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "Mode integration id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModeDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a Mode Analytics integration", "tags": [ "BI", "bi_modified" ] } }, "/api/v1/lineage/bi/powerbi/": { "post": { "operationId": "create_powerbi_integration_api_v1_lineage_bi_powerbi__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerBIDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Power BI integration", "tags": [ "BI", "BI", "bi_added" ] } }, "/api/v1/lineage/bi/powerbi/{bi_datasource_id}/": { "put": { "description": "Updates the integration configuration. Returns the integration with changed fields.", "operationId": "update_powerbi_integration_api_v1_lineage_bi_powerbi__bi_datasource_id___put", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "Power BI integration id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerBIDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a Power BI integration", "tags": [ "BI", "BI", "bi_modified" ] } }, "/api/v1/lineage/bi/tableau/": { "post": { "operationId": "create_tableau_integration_api_v1_lineage_bi_tableau__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableauDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Tableau integration", "tags": [ "BI", "bi_added" ] } }, "/api/v1/lineage/bi/tableau/{bi_datasource_id}/": { "put": { "description": "It can only update the schedule. Returns the integration with changed fields.", "operationId": "update_tableau_integration_api_v1_lineage_bi_tableau__bi_datasource_id___put", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "Tableau integration id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableauDataSourceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a Tableau integration", "tags": [ "BI", "bi_modified" ] } }, "/api/v1/lineage/bi/{bi_datasource_id}/": { "delete": { "operationId": "remove_integration_api_v1_lineage_bi__bi_datasource_id___delete", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "BI integration id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove an integration", "tags": [ "BI", "bi_deleted" ] }, "get": { "description": "Returns the integration for Mode/Tableau/Looker/HighTouch by its id.", "operationId": "get_integration_api_v1_lineage_bi__bi_datasource_id___get", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "BI integration id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get an integration", "tags": [ "BI" ] } }, "/api/v1/lineage/bi/{bi_datasource_id}/sync/": { "get": { "description": "Start an unscheduled synchronization of the integration.", "operationId": "resync_integration_api_v1_lineage_bi__bi_datasource_id__sync__get", "parameters": [ { "in": "path", "name": "bi_datasource_id", "required": true, "schema": { "title": "BI integration id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sync a BI integration", "tags": [ "BI" ] } }, "/api/v1/monitors": { "get": { "operationId": "list_monitors_api_v1_monitors_get", "parameters": [ { "description": "The page number to retrieve.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "description": "The page number to retrieve.", "title": "Page", "type": "integer" } }, { "description": "The number of items to retrieve per page.", "in": "query", "name": "page_size", "required": false, "schema": { "default": 20, "description": "The number of items to retrieve per page.", "title": "Page Size", "type": "integer" } }, { "description": "Field to order the monitors by.", "in": "query", "name": "order_by", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/SortableFields" }, { "type": "null" } ], "description": "Field to order the monitors by.", "title": "Order By" } }, { "description": "Specify the order direction for the monitors.", "in": "query", "name": "sort_order", "required": false, "schema": { "default": "desc", "description": "Specify the order direction for the monitors.", "enum": [ "asc", "desc" ], "title": "Sort Order", "type": "string" } }, { "description": "Comma-separated tags to filter monitors by.", "in": "query", "name": "tags", "required": false, "schema": { "description": "Comma-separated tags to filter monitors by.", "title": "Tags", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicListMonitorsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Monitors", "tags": [ "Monitors" ] } }, "/api/v1/monitors/create/diff": { "post": { "operationId": "create_monitor_diff_api_v1_monitors_create_diff_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiffMonitorSpecPublic" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicCreateMonitorOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Data Diff Monitor", "tags": [ "Monitors" ] } }, "/api/v1/monitors/create/metric": { "post": { "operationId": "create_monitor_metric_api_v1_monitors_create_metric_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricMonitorSpecPublic" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicCreateMonitorOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Metric Monitor", "tags": [ "Monitors" ] } }, "/api/v1/monitors/create/schema": { "post": { "operationId": "create_monitor_schema_api_v1_monitors_create_schema_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangeMonitorSpecPublic" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicCreateMonitorOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Schema Change Monitor", "tags": [ "Monitors" ] } }, "/api/v1/monitors/create/test": { "post": { "operationId": "create_monitor_test_api_v1_monitors_create_test_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTestMonitorSpecPublic" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicCreateMonitorOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create a Data Test Monitor", "tags": [ "Monitors" ] } }, "/api/v1/monitors/{id}": { "delete": { "operationId": "delete_monitor_api_v1_monitors__id__delete", "parameters": [ { "description": "The unique identifier of the monitor.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor.", "title": "Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete a Monitor", "tags": [ "Monitors" ] }, "get": { "operationId": "get_monitor_api_v1_monitors__id__get", "parameters": [ { "description": "The unique identifier of the monitor.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor.", "title": "Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicGetMonitorOutFull" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Monitor", "tags": [ "Monitors" ] } }, "/api/v1/monitors/{id}/run": { "post": { "operationId": "start_monitor_run_api_v1_monitors__id__run_post", "parameters": [ { "description": "The unique identifier of the monitor for which to start the run.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor for which to start the run.", "title": "Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicMonitorTriggerRunResultOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Trigger a run", "tags": [ "Monitors" ] } }, "/api/v1/monitors/{id}/runs": { "get": { "operationId": "list_monitor_runs_api_v1_monitors__id__runs_get", "parameters": [ { "description": "The unique identifier of the monitor.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor.", "title": "Id", "type": "integer" } }, { "description": "The page number to retrieve.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "description": "The page number to retrieve.", "title": "Page", "type": "integer" } }, { "description": "The number of items to retrieve per page.", "in": "query", "name": "page_size", "required": false, "schema": { "default": 10, "description": "The number of items to retrieve per page.", "title": "Page Size", "type": "integer" } }, { "description": "Include runs with a timestamp >= this value.", "in": "query", "name": "start_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Include runs with a timestamp >= this value.", "title": "Start Time" } }, { "description": "Include runs with a timestamp <= this value.", "in": "query", "name": "end_time", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Include runs with a timestamp <= this value.", "title": "End Time" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicListMonitorRunsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Monitor Runs", "tags": [ "Monitors" ] } }, "/api/v1/monitors/{id}/runs/{run_id}": { "get": { "operationId": "get_monitor_run_api_v1_monitors__id__runs__run_id__get", "parameters": [ { "description": "The unique identifier of the run to retrieve.", "in": "path", "name": "run_id", "required": true, "schema": { "description": "The unique identifier of the run to retrieve.", "title": "Run Id", "type": "integer" } }, { "description": "The unique identifier of the monitor associated with the run.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor associated with the run.", "title": "Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiPublicMonitorRunResultOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Monitor Run", "tags": [ "Monitors" ] } }, "/api/v1/monitors/{id}/toggle": { "put": { "operationId": "toggle_monitor_on_off_api_v1_monitors__id__toggle_put", "parameters": [ { "description": "The unique identifier of the monitor.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor.", "title": "Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_toggle_monitor_on_off_api_v1_monitors__id__toggle_put" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Toggle a Monitor", "tags": [ "Monitors" ] } }, "/api/v1/monitors/{id}/update": { "patch": { "operationId": "update_monitor_api_v1_monitors__id__update_patch", "parameters": [ { "description": "The unique identifier of the monitor.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the monitor.", "title": "Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "diff": "#/components/schemas/DataDiffUpdateMonitorSpecPublic", "metric": "#/components/schemas/MetricUpdateMonitorSpecPublic", "schema": "#/components/schemas/SchemaChangeUpdateMonitorSpecPublic", "test": "#/components/schemas/DataTestUpdateMonitorSpecPublic" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DataDiffUpdateMonitorSpecPublic" }, { "$ref": "#/components/schemas/MetricUpdateMonitorSpecPublic" }, { "$ref": "#/components/schemas/SchemaChangeUpdateMonitorSpecPublic" }, { "$ref": "#/components/schemas/DataTestUpdateMonitorSpecPublic" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update a Monitor", "tags": [ "Monitors" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "description": "Default server", "url": "https://app.datafold.com" } ] }