Skip to content

Commit

Permalink
Update swagger files.
Browse files Browse the repository at this point in the history
  • Loading branch information
@piotrczarnas
piotrczarnas committed Oct 29, 2024
1 parent b3ac3c5 commit f82ac88
Show file tree
Hide file tree
Showing 2 changed files with 244 additions and 0 deletions.
101 changes: 101 additions & 0 deletions dqops/src/main/resources/static/swagger-api/dqops-api-swagger-2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23980,6 +23980,10 @@
"description" : "Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range. Stores the most recent captured value for each day when the data quality check was evaluated.",
"$ref" : "#/definitions/ColumnSqlAggregateExpressionCheckSpec"
},
"daily_sql_invalid_value_count_on_column" : {
"description" : "Runs a custom query that retrieves invalid values found in a column and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a column, the condition can verify that the column has lower value than 18 using an SQL expression: `{alias}.{column} < 18`.",
"$ref" : "#/definitions/ColumnSqlConditionFailedCheckSpec"
},
"daily_import_custom_result_on_column" : {
"description" : "Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table.",
"$ref" : "#/definitions/ColumnSqlImportCustomResultCheckSpec"
Expand Down Expand Up @@ -24036,6 +24040,10 @@
"description" : "Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range. Stores the most recent check result for each month when the data quality check was evaluated.",
"$ref" : "#/definitions/ColumnSqlAggregateExpressionCheckSpec"
},
"monthly_sql_invalid_value_count_on_column" : {
"description" : "Runs a custom query that retrieves invalid values found in a column and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a column, the condition can verify that the column has lower value than 18 using an SQL expression: `{alias}.{column} < 18`.",
"$ref" : "#/definitions/ColumnSqlConditionFailedCheckSpec"
},
"monthly_import_custom_result_on_column" : {
"description" : "Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table.",
"$ref" : "#/definitions/ColumnSqlImportCustomResultCheckSpec"
Expand Down Expand Up @@ -24092,6 +24100,10 @@
"description" : "Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range.",
"$ref" : "#/definitions/ColumnSqlAggregateExpressionCheckSpec"
},
"profile_sql_invalid_value_count_on_column" : {
"description" : "Runs a custom query that retrieves invalid values found in a column and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a column, the condition can verify that the column has lower value than 18 using an SQL expression: `{alias}.{column} < 18`.",
"$ref" : "#/definitions/ColumnSqlConditionFailedCheckSpec"
},
"profile_import_custom_result_on_column" : {
"description" : "Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table.",
"$ref" : "#/definitions/ColumnSqlImportCustomResultCheckSpec"
Expand Down Expand Up @@ -43426,6 +43438,10 @@
"description" : "Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range. Stores the most recent captured value for each day when the data quality check was evaluated.",
"$ref" : "#/definitions/TableSqlAggregateExpressionCheckSpec"
},
"daily_sql_invalid_record_count_on_table" : {
"description" : "Runs a custom query that retrieves invalid records found in a table and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a *age* column, the condition can verify that the *age* is lower than 18 using an SQL expression: `{alias}.age < 18`.",
"$ref" : "#/definitions/TableSqlInvalidRecordCountCheckSpec"
},
"daily_import_custom_result_on_table" : {
"description" : "Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table.",
"$ref" : "#/definitions/TableSqlImportCustomResultCheckSpec"
Expand Down Expand Up @@ -43482,6 +43498,10 @@
"description" : "Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated.",
"$ref" : "#/definitions/TableSqlAggregateExpressionCheckSpec"
},
"monthly_sql_invalid_record_count_on_table" : {
"description" : "Runs a custom query that retrieves invalid records found in a table and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a *age* column, the condition can verify that the *age* is lower than 18 using an SQL expression: `{alias}.age < 18`.",
"$ref" : "#/definitions/TableSqlInvalidRecordCountCheckSpec"
},
"monthly_import_custom_result_on_table" : {
"description" : "Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table.",
"$ref" : "#/definitions/TableSqlImportCustomResultCheckSpec"
Expand Down Expand Up @@ -43538,6 +43558,10 @@
"description" : "Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range.",
"$ref" : "#/definitions/TableSqlAggregateExpressionCheckSpec"
},
"profile_sql_invalid_record_count_on_table" : {
"description" : "Runs a custom query that retrieves invalid records found in a table and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a *age* column, the condition can verify that the *age* is lower than 18 using an SQL expression: `{alias}.age < 18`.",
"$ref" : "#/definitions/TableSqlInvalidRecordCountCheckSpec"
},
"profile_import_custom_result_on_table" : {
"description" : "Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table.",
"$ref" : "#/definitions/TableSqlImportCustomResultCheckSpec"
Expand Down Expand Up @@ -46081,6 +46105,83 @@
}
}
},
"TableSqlInvalidRecordCountCheckSpec" : {
"type" : "object",
"properties" : {
"schedule_override" : {
"description" : "Run check scheduling configuration. Specifies the schedule (a cron expression) when the data quality checks are executed by the scheduler.",
"$ref" : "#/definitions/CronScheduleSpec"
},
"comments" : {
"type" : "array",
"description" : "Comments for change tracking. Please put comments in this collection because YAML comments may be removed when the YAML file is modified by the tool (serialization and deserialization will remove non tracked comments).",
"items" : {
"$ref" : "#/definitions/CommentSpec"
}
},
"disabled" : {
"type" : "boolean",
"description" : "Disables the data quality check. Only enabled data quality checks and monitorings are executed. The check should be disabled if it should not work, but the configuration of the sensor and rules should be preserved in the configuration."
},
"exclude_from_kpi" : {
"type" : "boolean",
"description" : "Data quality check results (alerts) are included in the data quality KPI calculation by default. Set this field to true in order to exclude this data quality check from the data quality KPI calculation."
},
"include_in_sla" : {
"type" : "boolean",
"description" : "Marks the data quality check as part of a data quality SLA (Data Contract). The data quality SLA is a set of critical data quality checks that must always pass and are considered as a Data Contract for the dataset."
},
"quality_dimension" : {
"type" : "string",
"description" : "Configures a custom data quality dimension name that is different than the built-in dimensions (Timeliness, Validity, etc.)."
},
"display_name" : {
"type" : "string",
"description" : "Data quality check display name that can be assigned to the check, otherwise the check_display_name stored in the parquet result files is the check_name."
},
"data_grouping" : {
"type" : "string",
"description" : "Data grouping configuration name that should be applied to this data quality check. The data grouping is used to group the check's result by a GROUP BY clause in SQL, evaluating the data quality check for each group of rows. Use the name of one of data grouping configurations defined on the parent table."
},
"always_collect_error_samples" : {
"type" : "boolean",
"description" : "Forces collecting error samples for this check whenever it fails, even if it is a monitoring check that is run by a scheduler, and running an additional query to collect error samples will impose additional load on the data source."
},
"do_not_schedule" : {
"type" : "boolean",
"description" : "Disables running this check by a DQOps CRON scheduler. When a check is disabled from scheduling, it can be only triggered from the user interface or by submitting \"run checks\" job."
},
"parameters" : {
"description" : "Sensor parameters with the custom SQL query, using a {table} placeholder to reference the current table.",
"$ref" : "#/definitions/TableSqlInvalidRecordCountSensorParametersSpec"
},
"warning" : {
"description" : "Alerting threshold that raises a data quality warning when a given number of rows failed the custom SQL condition (expression). The warning is considered as a passed data quality check.",
"$ref" : "#/definitions/MaxCountRule0WarningParametersSpec"
},
"error" : {
"description" : "Default alerting threshold for a maximum number of rows failing the custom SQL condition (expression) that raises a data quality error (alert).",
"$ref" : "#/definitions/MaxCountRule0ErrorParametersSpec"
},
"fatal" : {
"description" : "Alerting threshold that raises a fatal data quality issue when a given number of rows failed the custom SQL condition (expression). A fatal issue indicates a serious data quality problem that should result in stopping the data pipelines.",
"$ref" : "#/definitions/MaxCountRule100ParametersSpec"
}
}
},
"TableSqlInvalidRecordCountSensorParametersSpec" : {
"type" : "object",
"properties" : {
"filter" : {
"type" : "string",
"description" : "SQL WHERE clause added to the sensor query. Both the table level filter and a sensor query filter are added, separated by an AND operator."
},
"sql_query" : {
"type" : "string",
"description" : "SQL query that returns invalid values. The condition is evaluated for each row. The expression can use a {table} placeholder that is replaced with a full table name."
}
}
},
"TableStatisticsCollectorsRootCategoriesSpec" : {
"type" : "object",
"properties" : {
Expand Down
Loading

0 comments on commit f82ac88

Please sign in to comment.