Skip to content

Instantly share code, notes, and snippets.

@a-recknagel

a-recknagel/deepchecks-config.yaml

Created August 15, 2024 11:15
Show Gist options
  • Save a-recknagel/ede0b91c8055870bd2e9d96c96eb93ce to your computer and use it in GitHub Desktop.
Save a-recknagel/ede0b91c8055870bd2e9d96c96eb93ce to your computer and use it in GitHub Desktop.
Download ZIP
deepchecks-monitoring v1 openAPI spec
Raw
deepchecks-config.yaml
plugin: openapi
specFile: deepchecks-openapi-spec.json
Raw
deepchecks-openapi-spec.json
{
"openapi": "3.1.0",
"info": {
"title": "Deepchecks Monitoring",
"version": "0.1.0"
},
"paths": {
"/api/v1/say-hello": {
"get": {
"summary": "Hello World",
"operationId": "hello_world_api_v1_say_hello_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Hello World Api V1 Say Hello Get"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/backend-version": {
"get": {
"summary": "Retrieve Backend Version",
"operationId": "retrieve_backend_version_api_v1_backend_version_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/alerts/count_active": {
"get": {
"tags": [
"Alerts"
],
"summary": "Count Alerts",
"description": "Count alerts.",
"operationId": "count_alerts_api_v1_alerts_count_active_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Count Alerts Api V1 Alerts Count Active Get",
"type": "object",
"additionalProperties": {
"type": "integer"
}
}
}
}
}
}
}
},
"/api/v1/alerts/{alert_id}/resolve": {
"post": {
"tags": [
"Alerts"
],
"summary": "Resolve Alert",
"description": "Resolve alert by id.",
"operationId": "resolve_alert_api_v1_alerts__alert_id__resolve_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alerts/{alert_id}/reactivate": {
"post": {
"tags": [
"Alerts"
],
"summary": "Reactivate Alert",
"description": "Reactivate resolved alert.",
"operationId": "reactivate_alert_api_v1_alerts__alert_id__reactivate_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alerts/{alert_id}": {
"get": {
"tags": [
"Alerts"
],
"summary": "Get Alert",
"description": "Get alert by id.",
"operationId": "get_alert_api_v1_alerts__alert_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Alerts"
],
"summary": "Delete Alert",
"description": "Delete alert by id.",
"operationId": "delete_alert_api_v1_alerts__alert_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitors/{monitor_id}/alert-rules": {
"post": {
"tags": [
"Alerts"
],
"summary": "Create new alert rule on a given monitor.",
"description": "Create new alert rule on a given check.",
"operationId": "create_alert_rule_api_v1_monitors__monitor_id__alert_rules_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertRuleCreationSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Alerts"
],
"summary": "Get Alert Rules",
"description": "Return all the alert rules.\n\nParameters\n----------\nstart\nend\nmodels\nseverity\nsortby\nmonitor_id : int\n ID of a monitor to filter alert rules by.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nList[AlertSchema]\n All the alerts for a given monitor.",
"operationId": "get_alert_rules_api_v1_monitors__monitor_id__alert_rules_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"title": "Start",
"type": "string",
"format": "date-time"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"title": "End",
"type": "string",
"format": "date-time"
}
},
{
"name": "models",
"in": "query",
"required": false,
"schema": {
"title": "Models",
"default": [],
"type": "array",
"items": {
"type": "integer"
}
}
},
{
"name": "severity",
"in": "query",
"required": false,
"schema": {
"default": [],
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertSeverity"
}
}
},
{
"name": "is_active",
"in": "query",
"required": false,
"schema": {
"title": "Is Active",
"type": "boolean"
}
},
{
"name": "resolved",
"in": "query",
"required": false,
"schema": {
"title": "Resolved",
"type": "boolean"
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"title": "Sortby",
"default": [],
"type": "array",
"items": {
"enum": [
"severity:asc",
"severity:desc",
"alert-window:asc",
"alert-window:desc"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Alert Rules Api V1 Monitors Monitor Id Alert Rules Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertRuleInfoSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alert-rules": {
"get": {
"tags": [
"Alerts"
],
"summary": "Get Alert Rules",
"description": "Return all the alert rules.\n\nParameters\n----------\nstart\nend\nmodels\nseverity\nsortby\nmonitor_id : int\n ID of a monitor to filter alert rules by.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nList[AlertSchema]\n All the alerts for a given monitor.",
"operationId": "get_alert_rules_api_v1_alert_rules_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "query",
"required": false,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"title": "Start",
"type": "string",
"format": "date-time"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"title": "End",
"type": "string",
"format": "date-time"
}
},
{
"name": "models",
"in": "query",
"required": false,
"schema": {
"title": "Models",
"default": [],
"type": "array",
"items": {
"type": "integer"
}
}
},
{
"name": "severity",
"in": "query",
"required": false,
"schema": {
"default": [],
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertSeverity"
}
}
},
{
"name": "is_active",
"in": "query",
"required": false,
"schema": {
"title": "Is Active",
"type": "boolean"
}
},
{
"name": "resolved",
"in": "query",
"required": false,
"schema": {
"title": "Resolved",
"type": "boolean"
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"title": "Sortby",
"default": [],
"type": "array",
"items": {
"enum": [
"severity:asc",
"severity:desc",
"alert-window:asc",
"alert-window:desc"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Alert Rules Api V1 Alert Rules Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertRuleInfoSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alert-rules/{alert_rule_id}": {
"get": {
"tags": [
"Alerts"
],
"summary": "Get Alert Rule",
"description": "Get alert by id.",
"operationId": "get_alert_rule_api_v1_alert_rules__alert_rule_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertRuleSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Alerts"
],
"summary": "Update alert rule by id.",
"description": "Update alert by id.",
"operationId": "update_alert_api_v1_alert_rules__alert_rule_id__put",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Rule Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertRuleUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Alerts"
],
"summary": "Delete Alert Rule",
"description": "Delete alert by id.",
"operationId": "delete_alert_rule_api_v1_alert_rules__alert_rule_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alert-rules/{alert_rule_id}/alerts": {
"get": {
"tags": [
"Alerts"
],
"summary": "Get Alerts Of Alert Rule",
"description": "Get list of alerts raised by a given alert rule.",
"operationId": "get_alerts_of_alert_rule_api_v1_alert_rules__alert_rule_id__alerts_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Rule Id",
"type": "integer"
}
},
{
"name": "resolved",
"in": "query",
"required": false,
"schema": {
"title": "Resolved",
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Alerts Of Alert Rule Api V1 Alert Rules Alert Rule Id Alerts Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alert-rules/{alert_rule_id}/resolve-all": {
"post": {
"tags": [
"Alerts"
],
"summary": "Resolve All Alerts Of Alert Rule",
"description": "Resolve all alerts of alert rule.",
"operationId": "resolve_all_alerts_of_alert_rule_api_v1_alert_rules__alert_rule_id__resolve_all_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alert-rules/{alert_rule_id}/alerts/reactivate-resolved": {
"post": {
"tags": [
"Alerts"
],
"summary": "Reactivate Resolved Alerts",
"description": "Reactivate all resolved alerts",
"operationId": "reactivate_resolved_alerts_api_v1_alert_rules__alert_rule_id__alerts_reactivate_resolved_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/alert-webhooks": {
"get": {
"tags": [
"alert-webhooks"
],
"summary": "List Webhooks",
"description": "Retrieve all available alert webhooks",
"operationId": "list_webhooks_api_v1_alert_webhooks_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AlertWebhookSchema"
},
"type": "array",
"title": "Response List Webhooks Api V1 Alert Webhooks Get"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
},
"post": {
"tags": [
"alert-webhooks"
],
"summary": "Create Webhook",
"description": "Create alert webhook",
"operationId": "create_webhook_api_v1_alert_webhooks_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/StandardWebhookProperties"
},
{
"$ref": "#/components/schemas/PagerDutyWebhookProperties"
}
],
"title": "Webhook",
"discriminator": {
"propertyName": "kind",
"mapping": {
"STANDARD": "#/components/schemas/StandardWebhookProperties",
"PAGER_DUTY": "#/components/schemas/PagerDutyWebhookProperties"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "integer"
},
"type": "object",
"title": "Response Create Webhook Api V1 Alert Webhooks Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
}
},
"/api/v1/alert-webhooks/{webhook_id}": {
"get": {
"tags": [
"alert-webhooks"
],
"summary": "Retrive Webhook",
"description": "Retrieve alert webhook",
"operationId": "retrive_webhook_api_v1_alert_webhooks__webhook_id__get",
"parameters": [
{
"required": true,
"schema": {
"type": "integer",
"title": "Webhook Id"
},
"name": "webhook_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertWebhookSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
},
"put": {
"tags": [
"alert-webhooks"
],
"summary": "Update Webhook",
"description": "Update webhook",
"operationId": "update_webhook_api_v1_alert_webhooks__webhook_id__put",
"parameters": [
{
"required": true,
"schema": {
"type": "integer",
"title": "Webhook Id"
},
"name": "webhook_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PartialStandardWebhookProperties"
},
{
"$ref": "#/components/schemas/PartialPagerDutyWebhookProperties"
}
],
"title": "Data",
"discriminator": {
"propertyName": "kind",
"mapping": {
"STANDARD": "#/components/schemas/PartialStandardWebhookProperties",
"PAGER_DUTY": "#/components/schemas/PartialPagerDutyWebhookProperties"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
},
"delete": {
"tags": [
"alert-webhooks"
],
"summary": "Delete Webhook",
"description": "Delete alert webhook",
"operationId": "delete_webhook_api_v1_alert_webhooks__webhook_id__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "integer",
"title": "Webhook Id"
},
"name": "webhook_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
}
},
"/api/v1/models/{model_id}/checks": {
"post": {
"tags": [
"Checks"
],
"summary": "Add Checks",
"description": "Add a new check or checks to the model.\n\nParameters\n----------\nmodel_identifier : ModelIdentifier\n ID or name of the model.\nchecks: t.Union[CheckCreationSchema, t.List[CheckCreationSchema]]\n Check or checks to add to model.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nt.List[t.Dict[t.Any, t.Any]]\n List containing the names and ids for uploaded checks.",
"operationId": "add_checks_api_v1_models__model_id__checks_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Checks",
"anyOf": [
{
"$ref": "#/components/schemas/CheckCreationSchema"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckCreationSchema"
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Add Checks Api V1 Models Model Id Checks Post",
"type": "array",
"items": {
"$ref": "#/components/schemas/NameIdResponse"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Checks"
],
"summary": "Delete Checks By Name",
"description": "Delete check instances by name if they exist, otherwise returns 404.",
"operationId": "delete_checks_by_name_api_v1_models__model_id__checks_delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "names",
"in": "query",
"required": true,
"schema": {
"title": "Names",
"description": "Checks names",
"type": "array",
"items": {
"type": "string"
}
},
"description": "Checks names"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Checks"
],
"summary": "Get Checks",
"description": "Return all the checks for a given model.\n\nParameters\n----------\nmodel_identifier : ModelIdentifier\n ID or name of the model.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nList[CheckSchema]\n All the checks for a given model.",
"operationId": "get_checks_api_v1_models__model_id__checks_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Checks Api V1 Models Model Id Checks Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/checks/{check_id}": {
"delete": {
"tags": [
"Checks"
],
"summary": "Delete Check By Id",
"description": "Delete check instance by identifier.",
"operationId": "delete_check_by_id_api_v1_models__model_id__checks__check_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"description": "Check id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Check id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/auto-frequency": {
"get": {
"tags": [
"Checks"
],
"summary": "Get Model Auto Frequency",
"description": "Infer from the data the best frequency to show for analysis screen.",
"operationId": "get_model_auto_frequency_api_v1_models__model_id__auto_frequency_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoFrequencyResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/run/lookback": {
"post": {
"tags": [
"Checks"
],
"summary": "Run Standalone Check Per Window In Range",
"description": "Run a check for each time window by start-end.\n\nParameters\n----------\ncheck_id : int\n ID of the check.\nmonitor_options : MonitorOptions\n The \"monitor\" options.\nsession : AsyncSession, optional\n SQLAlchemy session.\nresources_provider: ResourcesProvider\n Resources provider.\n\nReturns\n-------\nCheckResultSchema\n Check run result.",
"operationId": "run_standalone_check_per_window_in_range_api_v1_checks__check_id__run_lookback_post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorOptions"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckResultSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/run/window": {
"post": {
"tags": [
"Checks"
],
"summary": "Get Check Window",
"description": "Run a check for the time window.\n\nParameters\n----------\ncheck_id : int\n ID of the check.\nmonitor_options : MonitorOptions\n The window options.\nsession : AsyncSession, optional\n SQLAlchemy session.\nresources_provider: ResourcesProvider\n Resources provider.\n\nReturns\n-------\ndict\n {<version_name: check_res>}.",
"operationId": "get_check_window_api_v1_checks__check_id__run_window_post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingleCheckRunOptions"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/run/reference": {
"post": {
"tags": [
"Checks"
],
"summary": "Get Check Reference",
"description": "Run a check on the reference data.\n\nParameters\n----------\ncheck_id : int\n ID of the check.\nmonitor_options : CheckRunOptions\n The monitor options.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\ndict\n {<version_name: check_res>}.",
"operationId": "get_check_reference_api_v1_checks__check_id__run_reference_post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckRunOptions"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/get-notebook": {
"post": {
"tags": [
"Checks"
],
"summary": "Get Notebook",
"description": "Run a check on a specified model version and returns a Jupyter notebook with the code to run the check.\n\nParameters\n----------\ncheck_id : int\n The id of the check to create a notebook to.\nnotebook_options : CheckNotebookSchema\n The options for the check notebook.\nsession : AsyncSession, default: AsyncSessionDep\n The database session to use.\nsettings : Settings, default: SettingsDep\n\nReturns\n-------\nPlainTextResponse\n A response containing the Jupyter notebook.",
"operationId": "get_notebook_api_v1_checks__check_id__get_notebook_post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckNotebookSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/info": {
"get": {
"tags": [
"Checks"
],
"summary": "Get Check Info",
"description": "Get the check configuration info and the possible values for the parameters.\n\nParameters\n----------\ncheck_id : int\n ID of the check.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nMonitorCheckConf\n the check configuration info and the possible values for the parameters.",
"operationId": "get_check_info_api_v1_checks__check_id__info_get",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorCheckConf"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/group-by/{model_version_id}/{feature}": {
"post": {
"tags": [
"Checks"
],
"summary": "Run Check Group By Feature",
"description": "Run check window with a group by on given feature.\n\nParameters\n----------\ncheck_id : int\n ID of the check.\nmodel_version_id : int\nfeature : str\n Feature to group by\nmonitor_options : SingleCheckRunOptions\n The monitor options.\nsession : AsyncSession\n SQLAlchemy session.\nresources_provider: ResourcesProvider\n Resources provider.\n\nReturns\n-------\nList[CheckGroupBySchema]",
"operationId": "run_check_group_by_feature_api_v1_checks__check_id__group_by__model_version_id___feature__post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
},
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
},
{
"name": "feature",
"in": "path",
"required": true,
"schema": {
"title": "Feature",
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingleCheckRunOptions"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Run Check Group By Feature Api V1 Checks Check Id Group By Model Version Id Feature Post",
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckGroupBySchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/checks/{check_id}/display/{model_version_id}": {
"post": {
"tags": [
"Checks"
],
"summary": "Get Check Display",
"operationId": "get_check_display_api_v1_checks__check_id__display__model_version_id__post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
},
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingleCheckRunOptions"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Check Display Api V1 Checks Check Id Display Model Version Id Post",
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/alert-rules": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get All Alert Rules",
"description": "Return all alert rules for the configuration screen.\n\nParameters\n----------\nmodels : list, optional\n The list of models to filter by.\nseverity : list, optional\n The list of severities to filter by.\nsortby : list, optional\n The list of columns to sort by.\nsession : AsyncSession, optional\n The database connection.\n\nReturns\n-------\nlist\n The list of alert rules.",
"operationId": "get_all_alert_rules_api_v1_config_alert_rules_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "models",
"in": "query",
"required": false,
"schema": {
"title": "Models",
"default": [],
"type": "array",
"items": {
"type": "integer"
}
}
},
{
"name": "severity",
"in": "query",
"required": false,
"schema": {
"default": [],
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertSeverity"
}
}
},
{
"name": "sortby",
"in": "query",
"required": false,
"schema": {
"title": "Sortby",
"default": [],
"type": "array",
"items": {
"enum": [
"severity:asc",
"severity:desc"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get All Alert Rules Api V1 Config Alert Rules Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertRuleConfigSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/configurations": {
"get": {
"summary": "Application Configurations",
"description": "Return the application configurations for the client.",
"operationId": "application_configurations_api_v1_configurations_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/checks/{check_id}/monitors": {
"post": {
"tags": [
"Monitors"
],
"summary": "Create a new monitor.",
"description": "Create a new monitor based on a check. This endpoint requires the name, lookback, data_filter and description of the monitor.",
"operationId": "create_monitor_api_v1_checks__check_id__monitors_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "check_id",
"in": "path",
"required": true,
"schema": {
"title": "Check Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorCreationSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitors/{monitor_id}": {
"get": {
"tags": [
"Monitors"
],
"summary": "Get Monitor",
"description": "Get monitor by id.",
"operationId": "get_monitor_api_v1_monitors__monitor_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Monitors"
],
"summary": "Update Monitor",
"description": "Update monitor by id.",
"operationId": "update_monitor_api_v1_monitors__monitor_id__put",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Monitors"
],
"summary": "Delete Monitor",
"description": "Delete monitor by id.",
"operationId": "delete_monitor_api_v1_monitors__monitor_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitors/{monitor_id}/get-notebook": {
"post": {
"tags": [
"Monitors"
],
"summary": "Get Notebook",
"description": "Run a check on a specified model version and returns a Jupyter notebook with the code to run the check.\n\nParameters\n----------\nmonitor_id : int\n The id of the monitor to create a notebook to.\nnotebook_options : MonitorNotebookSchema\n The options for the notebook.\nsession : AsyncSession, default: AsyncSessionDep\n The database session to use.\nsettings : Settings, default: SettingsDep\n\nReturns\n-------\nPlainTextResponse\n A response containing the Jupyter notebook.",
"operationId": "get_notebook_api_v1_monitors__monitor_id__get_notebook_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorNotebookSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitors/{monitor_id}/run": {
"post": {
"tags": [
"Monitors"
],
"summary": "Run Monitor Lookback",
"description": "Run a monitor for each time window by lookback.\n\nParameters\n----------\nmonitor_id : int\n ID of the monitor.\nbody\nsession : AsyncSession, optional\n SQLAlchemy session.\ncache_funcs\nuser\nresources_provider: ResourcesProvider\n Resources provider.\n\nReturns\n-------\nCheckResultSchema\n Check run result.",
"operationId": "run_monitor_lookback_api_v1_monitors__monitor_id__run_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "monitor_id",
"in": "path",
"required": true,
"schema": {
"title": "Monitor Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitorRunSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckResultSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/dashboards": {
"get": {
"tags": [
"Monitors"
],
"summary": "Get Or Create Dashboard",
"description": "Get dashboard by if exists, if not then create it. Add top 5 unassigned monitors to the dashboard if empty.",
"operationId": "get_or_create_dashboard_api_v1_dashboards_get",
"security": [
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardSchema"
}
}
}
}
}
}
},
"/api/v1/dashboards/{dashboard_id}": {
"put": {
"tags": [
"Monitors"
],
"summary": "Update Dashboard",
"description": "Update dashboard by id.",
"operationId": "update_dashboard_api_v1_dashboards__dashboard_id__put",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"schema": {
"title": "Dashboard Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Monitors"
],
"summary": "Delete Dashboard",
"description": "Delete dashboard by id.",
"operationId": "delete_dashboard_api_v1_dashboards__dashboard_id__delete",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"schema": {
"title": "Dashboard Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alerts/count_active": {
"get": {
"tags": [
"Data Alerts"
],
"summary": "Count Alerts",
"description": "Count alerts.",
"operationId": "count_alerts_api_v1_data_ingestion_alerts_count_active_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Count Alerts Api V1 Data Ingestion Alerts Count Active Get",
"type": "object",
"additionalProperties": {
"type": "integer"
}
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alerts/{data_ingestion_alert_id}/resolve": {
"post": {
"tags": [
"Data Alerts"
],
"summary": "Resolve Alert",
"description": "Resolve alert by id.",
"operationId": "resolve_alert_api_v1_data_ingestion_alerts__data_ingestion_alert_id__resolve_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alerts/{data_ingestion_alert_id}/reactivate": {
"post": {
"tags": [
"Data Alerts"
],
"summary": "Reactivate Alert",
"description": "Reactivate resolved alert.",
"operationId": "reactivate_alert_api_v1_data_ingestion_alerts__data_ingestion_alert_id__reactivate_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alerts/{data_ingestion_alert_id}": {
"get": {
"tags": [
"Data Alerts"
],
"summary": "Get Alert",
"description": "Get alert by id.",
"operationId": "get_alert_api_v1_data_ingestion_alerts__data_ingestion_alert_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataIngestionAlertSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Data Alerts"
],
"summary": "Delete Alert",
"description": "Delete alert by id.",
"operationId": "delete_alert_api_v1_data_ingestion_alerts__data_ingestion_alert_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/data-ingestion-alert-rules": {
"post": {
"tags": [
"Data Alerts"
],
"summary": "Create new alert rule on a given model.",
"description": "Create new alert rule on a given check.",
"operationId": "create_alert_rule_api_v1_models__model_id__data_ingestion_alert_rules_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataIngestionAlertRuleCreationSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alert-rules/{data_ingestion_alert_rule_id}": {
"get": {
"tags": [
"Data Alerts"
],
"summary": "Get Alert Rule",
"description": "Get data-ingestion alert rule by id.",
"operationId": "get_alert_rule_api_v1_data_ingestion_alert_rules__data_ingestion_alert_rule_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataIngestionAlertRuleSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Data Alerts"
],
"summary": "Update data-ingestion alert rule by id.",
"description": "Update data-ingestion alert rule by id.",
"operationId": "update_alert_api_v1_data_ingestion_alert_rules__data_ingestion_alert_rule_id__put",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Rule Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataIngestionAlertRuleUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Data Alerts"
],
"summary": "Delete Alert Rule",
"description": "Delete data-ingestion alert rule by id.",
"operationId": "delete_alert_rule_api_v1_data_ingestion_alert_rules__data_ingestion_alert_rule_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alert-rules/{data_ingestion_alert_rule_id}/alerts": {
"get": {
"tags": [
"Data Alerts"
],
"summary": "Get Alerts Of Alert Rule",
"description": "Get list of alerts raised by a given data-ingestion alert rule.",
"operationId": "get_alerts_of_alert_rule_api_v1_data_ingestion_alert_rules__data_ingestion_alert_rule_id__alerts_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Rule Id",
"type": "integer"
}
},
{
"name": "resolved",
"in": "query",
"required": false,
"schema": {
"title": "Resolved",
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Alerts Of Alert Rule Api V1 Data Ingestion Alert Rules Data Ingestion Alert Rule Id Alerts Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/DataIngestionAlertSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alert-rules/{data_ingestion_alert_rule_id}/resolve-all": {
"post": {
"tags": [
"Data Alerts"
],
"summary": "Resolve All Alerts Of Alert Rule",
"description": "Resolve all alerts of alert rule.",
"operationId": "resolve_all_alerts_of_alert_rule_api_v1_data_ingestion_alert_rules__data_ingestion_alert_rule_id__resolve_all_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-ingestion-alert-rules/{data_ingestion_alert_rule_id}/alerts/reactivate-resolved": {
"post": {
"tags": [
"Data Alerts"
],
"summary": "Reactivate Resolved Alerts",
"description": "Reactivate all resolved alerts",
"operationId": "reactivate_resolved_alerts_api_v1_data_ingestion_alert_rules__data_ingestion_alert_rule_id__alerts_reactivate_resolved_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_ingestion_alert_rule_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Ingestion Alert Rule Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/data": {
"post": {
"tags": [
"Data"
],
"summary": "Log inference data per model version.",
"description": "This API logs asynchronously a batch of new samples of the inference data of an existing model version, it requires the actual data and validates it matches the version schema.",
"operationId": "log_data_batch_api_v1_model_versions__model_version_id__data_post",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Data",
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model/{model_id}/labels": {
"put": {
"tags": [
"Data"
],
"summary": "Log Labels",
"description": "Update data samples.",
"operationId": "log_labels_api_v1_model__model_id__labels_put",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Data",
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/reference": {
"post": {
"tags": [
"Data"
],
"summary": "Upload reference data for a given model version.",
"description": "This API uploads asynchronously a reference data file for a given model version,it requires the actual data and validates it matches the version schema.",
"operationId": "save_reference_api_v1_model_versions__model_version_id__reference_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_save_reference_api_v1_model_versions__model_version_id__reference_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models": {
"post": {
"tags": [
"Models"
],
"summary": "Create a new model if does not exist.",
"description": "Create a new model with its name, task type, and description. Returns the ID of the model. If the model already exists, returns the ID of the existing model.",
"operationId": "get_create_model_api_v1_models_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelCreationSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/data-ingestion": {
"get": {
"tags": [
"Models"
],
"summary": "Retrieve All Models Data Ingestion",
"description": "Retrieve all models data ingestion statistics.",
"operationId": "retrieve_all_models_data_ingestion_api_v1_models_data_ingestion_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "time_filter",
"in": "query",
"required": false,
"schema": {
"title": "Time Filter",
"default": 86400,
"type": "integer"
}
},
{
"name": "end_time",
"in": "query",
"required": false,
"schema": {
"title": "End Time",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve All Models Data Ingestion Api V1 Models Data Ingestion Get",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelDailyIngestion"
}
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/data-ingestion": {
"get": {
"tags": [
"Models"
],
"summary": "Retrieve Models Data Ingestion",
"description": "Retrieve model data ingestion statistics.",
"operationId": "retrieve_models_data_ingestion_api_v1_models__model_id__data_ingestion_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "time_filter",
"in": "query",
"required": false,
"schema": {
"title": "Time Filter",
"default": 86400,
"type": "integer"
}
},
{
"name": "end_time",
"in": "query",
"required": false,
"schema": {
"title": "End Time",
"type": "string"
}
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Models Data Ingestion Api V1 Models Model Id Data Ingestion Get",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelDailyIngestion"
}
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}": {
"get": {
"tags": [
"Models"
],
"summary": "Get Model",
"description": "Get a model from database based on model id.\n\nParameters\n----------\nmodel_identifier : ModelIdentifier\n Model to return.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nModelSchema\n Requested model.",
"operationId": "get_model_api_v1_models__model_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Models",
"models-managment"
],
"summary": "Delete Model",
"description": "Delete model",
"operationId": "delete_model_api_v1_models__model_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/versions": {
"get": {
"tags": [
"Models"
],
"summary": "Get Versions Per Model",
"description": "Create a new model.\n\nParameters\n----------\nmodel_identifier : ModelIdentifier\n Model to return.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nNameIdResponse\n Created model.",
"operationId": "get_versions_per_model_api_v1_models__model_id__versions_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Versions Per Model Api V1 Models Model Id Versions Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/NameIdResponse"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/available-models": {
"get": {
"tags": [
"Models",
"models-managment"
],
"summary": "Retrieve Available Models",
"description": "Retrieve list of available models.",
"operationId": "retrieve_available_models_api_v1_available_models_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "show_all",
"in": "query",
"required": false,
"schema": {
"title": "Show All",
"default": false,
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Available Models Api V1 Available Models Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelManagmentSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/columns": {
"get": {
"tags": [
"Models"
],
"summary": "Get Model Columns",
"description": "Get statistics of columns for model.\n\nParameters\n----------\nmodel_identifier : ModelIdentifier\n Identifier of a model column of which to return.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nDict[str, ColumnMetadata]\n Column name and metadata (type and value if available).",
"operationId": "get_model_columns_api_v1_models__model_id__columns_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Model Columns Api V1 Models Model Id Columns Get",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ColumnMetadata"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/connected-models": {
"get": {
"tags": [
"Models",
"connected-models"
],
"summary": "Retrieve Connected Models",
"description": "Retrieve list of connected models.",
"operationId": "retrieve_connected_models_api_v1_connected_models_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Connected Models Api V1 Connected Models Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectedModelSchema"
}
}
}
}
}
}
}
},
"/api/v1/connected-models/{model_id}/versions": {
"get": {
"tags": [
"Models",
"connected-models"
],
"summary": "Retrive Connected Model Versions",
"description": "Retrieve list of versions of a connected model.",
"operationId": "retrive_connected_model_versions_api_v1_connected_models__model_id__versions_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrive Connected Model Versions Api V1 Connected Models Model Id Versions Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectedModelVersionSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/connected-models/{model_id}/versions/{version_id}/ingestion-errors": {
"get": {
"tags": [
"Models",
"connected-models"
],
"summary": "Retrieve Connected Model Version Ingestion Errors",
"description": "Retrieve connected model version ingestion errors.",
"operationId": "retrieve_connected_model_version_ingestion_errors_api_v1_connected_models__model_id__versions__version_id__ingestion_errors_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"type": "integer"
}
},
{
"name": "version_id",
"in": "path",
"required": true,
"schema": {
"title": "Version Id",
"type": "integer"
}
},
{
"name": "sort_key",
"in": "query",
"required": false,
"schema": {
"default": "timestamp",
"allOf": [
{
"$ref": "#/components/schemas/IngestionErrorsSortKey"
}
]
}
},
{
"name": "sort_order",
"in": "query",
"required": false,
"schema": {
"default": "desc",
"allOf": [
{
"$ref": "#/components/schemas/SortOrder"
}
]
}
},
{
"name": "download",
"in": "query",
"required": false,
"schema": {
"title": "Download",
"default": false,
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"title": "Limit",
"default": 50,
"minimum": 1,
"maximum": 10000,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"title": "Offset",
"default": 0,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Connected Model Version Ingestion Errors Api V1 Connected Models Model Id Versions Version Id Ingestion Errors Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/IngestionErrorSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/connected-models/{model_id}/ingestion-errors": {
"get": {
"tags": [
"Models",
"connected-models"
],
"summary": "Retrieve Connected Model Ingestion Errors",
"description": "Retrieve connected model ingestion errors.",
"operationId": "retrieve_connected_model_ingestion_errors_api_v1_connected_models__model_id__ingestion_errors_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"type": "integer"
}
},
{
"name": "sort_key",
"in": "query",
"required": false,
"schema": {
"default": "timestamp",
"allOf": [
{
"$ref": "#/components/schemas/IngestionErrorsSortKey"
}
]
}
},
{
"name": "msg_contains",
"in": "query",
"required": false,
"schema": {
"title": "Msg Contains",
"type": "string"
}
},
{
"name": "model_version_id",
"in": "query",
"required": false,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
},
{
"name": "sort_order",
"in": "query",
"required": false,
"schema": {
"default": "desc",
"allOf": [
{
"$ref": "#/components/schemas/SortOrder"
}
]
}
},
{
"name": "download",
"in": "query",
"required": false,
"schema": {
"title": "Download",
"default": false,
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"title": "Limit",
"default": 50,
"minimum": 1,
"maximum": 10000,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"title": "Offset",
"default": 0,
"minimum": 0,
"type": "integer"
}
},
{
"name": "start_time_epoch",
"in": "query",
"required": false,
"schema": {
"title": "Start Time Epoch",
"type": "integer"
}
},
{
"name": "end_time_epoch",
"in": "query",
"required": false,
"schema": {
"title": "End Time Epoch",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Connected Model Ingestion Errors Api V1 Connected Models Model Id Ingestion Errors Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/IngestionErrorSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/monitors-set-schedule-time": {
"post": {
"tags": [
"Models",
"Monitors"
],
"summary": "Set new scheduling time for all monitors of the model.",
"description": "Set schedule time.",
"operationId": "set_schedule_time_api_v1_models__model_id__monitors_set_schedule_time_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelScheduleTimeSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/notes": {
"get": {
"tags": [
"Models"
],
"summary": "Retrieve model notes.",
"operationId": "retrieve_model_notes_api_v1_models__model_id__notes_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Model Notes Api V1 Models Model Id Notes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelNoteSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Models"
],
"summary": "Create model notes.",
"operationId": "create_model_notes_api_v1_models__model_id__notes_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Notes",
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelNoteCreationSchema"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Create Model Notes Api V1 Models Model Id Notes Post",
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelNoteSchema"
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models-notes/{model_note_id}": {
"delete": {
"tags": [
"Models"
],
"summary": "Delete model note.",
"operationId": "delete_model_note_api_v1_models_notes__model_note_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_note_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Note Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/version": {
"post": {
"tags": [
"Models"
],
"summary": "Get Or Create Version",
"description": "Create a new model version.\n\nParameters\n----------\nmodel_identifier : ModelIdentifier\n ID or name of the model.\ninfo : VersionInfo\n Information about the model version.\nsession : AsyncSession, optional\n SQLAlchemy session.",
"operationId": "get_or_create_version_api_v1_models__model_id__version_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"description": "Model id or name",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"description": "Model id or name"
},
{
"name": "identifier_kind",
"in": "query",
"required": false,
"schema": {
"description": "A flag that indicates which kind of entity identifier to use: id or name",
"default": "id",
"allOf": [
{
"$ref": "#/components/schemas/IdentifierKind"
}
]
},
"description": "A flag that indicates which kind of entity identifier to use: id or name"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelVersionCreationSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}": {
"put": {
"tags": [
"Models"
],
"summary": "Update Model Version",
"description": "Update model version",
"operationId": "update_model_version_api_v1_model_versions__model_version_id__put",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelVersionUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Models"
],
"summary": "Retrieve Model Version By Id",
"description": "Retrieve model version.",
"operationId": "retrieve_model_version_by_id_api_v1_model_versions__model_version_id__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelVersionSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Models"
],
"summary": "Delete Model Version By Id",
"description": "Delete model version by unique numerical identifier",
"operationId": "delete_model_version_by_id_api_v1_model_versions__model_version_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"description": "Model version id",
"type": "integer"
},
"description": "Model version id"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_name}/model-versions/{version_name}": {
"get": {
"tags": [
"Models"
],
"summary": "Retrieve Model Version By Name",
"description": "Retrieve model version.",
"operationId": "retrieve_model_version_by_name_api_v1_models__model_name__model_versions__version_name__get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_name",
"in": "path",
"required": true,
"schema": {
"title": "Model Name",
"description": "Model name.",
"type": "string"
},
"description": "Model name."
},
{
"name": "version_name",
"in": "path",
"required": true,
"schema": {
"title": "Version Name",
"description": "Model version name.",
"type": "string"
},
"description": "Model version name."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelVersionSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Models"
],
"summary": "Delete Model Version By Name",
"description": "Delete model version.",
"operationId": "delete_model_version_by_name_api_v1_models__model_name__model_versions__version_name__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_name",
"in": "path",
"required": true,
"schema": {
"title": "Model Name",
"description": "Model name",
"type": "string"
},
"description": "Model name"
},
{
"name": "version_name",
"in": "path",
"required": true,
"schema": {
"title": "Version Name",
"description": "Model version name",
"type": "string"
},
"description": "Model version name"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/schema": {
"get": {
"tags": [
"Models"
],
"summary": "Get Schema",
"description": "Return json schema of the model version data to use in validation on client-side.\n\nParameters\n----------\nmodel_version_id : int\n Version id to run function on.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\ndictionary containing:\n json schema of the monitored data in model version\n json schema of the reference data in model version\n feature columns schema\n non-feature columns schema",
"operationId": "get_schema_api_v1_model_versions__model_version_id__schema_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/suite-run": {
"post": {
"tags": [
"Checks"
],
"summary": "Run Suite On Model Version",
"description": "Run suite (all checks defined) on given model version.\n\nParameters\n----------\nmodel_version_id : int\n Version id to run function on.\nmonitor_options\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\nHTML of the suite result.",
"operationId": "run_suite_on_model_version_api_v1_model_versions__model_version_id__suite_run_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingleCheckRunOptions"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/get-ref-data": {
"post": {
"tags": [
"Models"
],
"summary": "Get Model Version Ref Data",
"description": "Get reference data for a model version.\n\nParameters\n----------\nmodel_version_id : int\n The id of the model version.\nmonitor_options : TableDataSchema\n The options for the monitor data.\nsession : AsyncSession\n The database session.\n\nReturns\n-------\nORJSONResponse\n The reference data in a json format.",
"operationId": "get_model_version_ref_data_api_v1_model_versions__model_version_id__get_ref_data_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableDataSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/get-prod-data": {
"post": {
"tags": [
"Models"
],
"summary": "Get Model Version Prod Data",
"description": "Get reference data for a model version.\n\nParameters\n----------\nmodel_version_id : int\n The id of the model version.\nmonitor_options : WindowDataSchema\n The options for the monitor data.\nsession : AsyncSession\n The database session.\n\nReturns\n-------\nORJSONResponse\n The production data in a json format.",
"operationId": "get_model_version_prod_data_api_v1_model_versions__model_version_id__get_prod_data_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WindowDataSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/time-window-statistics": {
"get": {
"tags": [
"Data"
],
"summary": "Get Time Window Statistics",
"description": "Return a json containing statistics on samples in the provided time window.\n\nParameters\n----------\nmodel_version_id : int\n Version id to run function on.\nbody : TimeWindowSchema\n Description of the time window to provide statistics for.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\njson schema of the model version",
"operationId": "get_time_window_statistics_api_v1_model_versions__model_version_id__time_window_statistics_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeWindowSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeWindowOutputStatsSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/model-versions/{model_version_id}/count-samples": {
"get": {
"tags": [
"Models"
],
"summary": "Get Count Samples",
"description": "Return json schema of the model version data to use in validation on client-side.\n\nParameters\n----------\nmodel_version_id : int\n Version id to run function on.\nsession : AsyncSession, optional\n SQLAlchemy session.\n\nReturns\n-------\njson schema of the model version",
"operationId": "get_count_samples_api_v1_model_versions__model_version_id__count_samples_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_version_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Version Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/onboarding": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get onboarding state",
"description": "Get onboarding state.\n\nParameters\n----------\nmodel_name : t.Optional[str]\n Optional to specify a specific model.\nsession : AsyncSession\n SQLAlchemy session.",
"operationId": "get_onboarding_state_api_v1_onboarding_get",
"security": [
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_name",
"in": "query",
"required": false,
"schema": {
"title": "Model Name",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StepSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/auth/login/auth0": {
"get": {
"tags": [
"security"
],
"summary": "Auth0 Login",
"description": "Redirect to the Auth0 login page.",
"operationId": "auth0_login_api_v1_auth_login_auth0_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/auth/login/auth0/callback": {
"get": {
"tags": [
"security"
],
"summary": "Auth0 Callback",
"description": "Get the user details from the Auth0 callback.",
"operationId": "auth0_callback_api_v1_auth_login_auth0_callback_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/auth/logout": {
"get": {
"tags": [
"security"
],
"summary": "Logout",
"description": "Logout the user.",
"operationId": "logout_api_v1_auth_logout_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/health-check": {
"get": {
"summary": "Health Check",
"description": "Health check endpoint.\n\nReturns\n-------\n Response: A 200 OK response.",
"operationId": "health_check_api_v1_health_check_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/organization/invite": {
"put": {
"tags": [
"organization"
],
"summary": "Create Invite",
"description": "Create invite between organization and a user.",
"operationId": "create_invite_api_v1_organization_invite_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationCreationSchema"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/organization": {
"get": {
"tags": [
"organization"
],
"summary": "Retrive Organization",
"description": "Retrive an organization.",
"operationId": "retrive_organization_api_v1_organization_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/deepchecks_monitoring__api__v1__global_api__organization__OrganizationSchema"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
},
"put": {
"tags": [
"organization"
],
"summary": "Update Organization",
"description": "Update an organization.",
"operationId": "update_organization_api_v1_organization_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationUpdateSchema"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
},
"delete": {
"summary": "Remove Organization",
"description": "Remove an organization.",
"operationId": "remove_organization_api_v1_organization_delete",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/organization/members": {
"get": {
"tags": [
"organization"
],
"summary": "Retrieve Organization Members",
"description": "Retrieve organization members",
"operationId": "retrieve_organization_members_api_v1_organization_members_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/MemberSchema"
},
"type": "array",
"title": "Response Retrieve Organization Members Api V1 Organization Members Get"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/organization/members/{member_id}": {
"delete": {
"tags": [
"organization"
],
"summary": "Remove Organization Member",
"description": "Remove member from an organization",
"operationId": "remove_organization_member_api_v1_organization_members__member_id__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "integer",
"title": "Member Id"
},
"name": "member_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/organization/leave": {
"post": {
"tags": [
"organization"
],
"summary": "Leave Organization",
"description": "Leave the organization",
"operationId": "leave_organization_api_v1_organization_leave_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/organization/available-features": {
"get": {
"tags": [
"organization"
],
"summary": "Get Available Features",
"description": "Get available features",
"operationId": "get_available_features_api_v1_organization_available_features_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeaturesSchema"
}
}
}
}
},
"security": [
{
"AccessBearer": []
}
]
}
},
"/api/v1/users/complete-details": {
"get": {
"tags": [
"Users"
],
"summary": "Get Complete Details",
"description": "Get info needed for the complete details page.",
"operationId": "get_complete_details_api_v1_users_complete_details_get",
"security": [
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteDetailsSchema"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Update Complete Details",
"description": "Complete user details for final login.",
"operationId": "update_complete_details_api_v1_users_complete_details_post",
"security": [
{
"AccessBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteDetailsUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/users": {
"delete": {
"tags": [
"Users"
],
"summary": "Delete User",
"description": "Delete the user.",
"operationId": "delete_user_api_v1_users_delete",
"security": [
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/users/me": {
"get": {
"tags": [
"Users"
],
"summary": "Retrieve User Info",
"description": "Retrieve user details",
"operationId": "retrieve_user_info_api_v1_users_me_get",
"security": [
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSchema"
}
}
}
}
}
}
},
"/api/v1/users/regenerate-api-token": {
"get": {
"tags": [
"Users"
],
"summary": "Regenerate Api Token",
"description": "Regenerate user token",
"operationId": "regenerate_api_token_api_v1_users_regenerate_api_token_get",
"security": [
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Regenerate Api Token Api V1 Users Regenerate Api Token Get",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/users/accept-eula": {
"get": {
"tags": [
"Users"
],
"summary": "Eula-Acceptance",
"description": "Accept End-User License Aggrement",
"operationId": "eula_acceptance_api_v1_users_accept_eula_get",
"security": [
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/data-sources": {
"get": {
"tags": [
"Data Sources"
],
"summary": "Get Data Sources",
"operationId": "get_data_sources_api_v1_data_sources_get",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Data Sources Api V1 Data Sources Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceSchema"
}
}
}
}
}
}
},
"put": {
"tags": [
"Data Sources"
],
"summary": "New Data Source",
"operationId": "new_data_source_api_v1_data_sources_put",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSourceCreationSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/data-sources/{data_source_id}": {
"delete": {
"tags": [
"Data Sources"
],
"summary": "Delete Data Source",
"operationId": "delete_data_source_api_v1_data_sources__data_source_id__delete",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"title": "Data Source Id",
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/users/{user_id}/roles": {
"put": {
"tags": [
"Users"
],
"summary": "Update User Role",
"description": "Update user roles.",
"operationId": "update_user_role_api_v1_users__user_id__roles_put",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"title": "User Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/users/{user_id}/models": {
"post": {
"tags": [
"Users"
],
"summary": "Assign Models To User",
"description": "Assign models to user.",
"operationId": "assign_models_to_user_api_v1_users__user_id__models_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"title": "User Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/models/{model_id}/members": {
"post": {
"tags": [
"Models"
],
"summary": "Assign Users To Model",
"description": "Assign users to model.",
"operationId": "assign_users_to_model_api_v1_models__model_id__members_post",
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
],
"parameters": [
{
"name": "model_id",
"in": "path",
"required": true,
"schema": {
"title": "Model Id",
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchModelMemberUpdateSchema"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/slack.authorize": {
"get": {
"tags": [
"slack"
],
"summary": "Slack-Authorization-Redirect",
"description": "Redirect user to the slack authorization page.\n\ncodeflow:\n1. Authenticate user\n2. Verify whether user has permissions to do operation\n3. Issue 'installation state' to prevent forgery attack\n4. Generate redirection URL\n5. Set 'installation state' cookie\n6. Redirect user to slack authorization page.\n\nSlack authorization URL description:\nhttps://slack.com/oauth/v2/authorize?state=&client_id=&scope=&user_scope=\nstate - installation state, slack will include it in request with exchange code\nclient_id - application client id\nscope - list of bot permissions\nuser_scope -",
"operationId": "slack_authorization_redirect_api_v1_slack_authorize_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
}
},
"/api/v1/slack.install": {
"get": {
"tags": [
"slack"
],
"summary": "Slack-Installation-Callback",
"description": "Finish slack installation.\n\nWhen a user confirms application (bot) installation,\nslack redirects him back to the 'redirect_uri' URL\nprovided within the authorization request.\n\nSlack will include the next query parameters with the redirection URL:\ncode - access token exchange code\nerror - error message if something went wrong\nstate - installation state token that was passed with an authorization request.",
"operationId": "slack_installation_callback_api_v1_slack_install_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Code"
},
"name": "code",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Error"
},
"name": "error",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "State"
},
"name": "state",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
}
},
"/api/v1/slack/apps": {
"get": {
"tags": [
"slack"
],
"summary": "Retrieve Instalations",
"description": "Return list of slack installations.",
"operationId": "retrieve_instalations_api_v1_slack_apps_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
}
},
"/api/v1/slack/apps/{app_id}": {
"delete": {
"tags": [
"slack"
],
"summary": "Remove Installation",
"description": "Remove slack installation.",
"operationId": "remove_installation_api_v1_slack_apps__app_id__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "integer",
"title": "App Id"
},
"name": "app_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"AccessBearer": []
},
{
"AccessBearer": []
}
]
}
}
},
"components": {
"schemas": {
"AlertRuleConfigSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"frequency": {
"$ref": "#/components/schemas/Frequency"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"total_alerts": {
"type": "integer",
"title": "Total Alerts",
"default": 0
},
"non_resolved_alerts": {
"type": "integer",
"title": "Non Resolved Alerts",
"default": 0
},
"recent_alert": {
"type": "string",
"format": "date-time",
"title": "Recent Alert"
},
"user": {
"$ref": "#/components/schemas/BasicUserSchema"
},
"check_name": {
"type": "string",
"title": "Check Name"
}
},
"type": "object",
"required": [
"id",
"name",
"frequency",
"condition",
"check_name"
],
"title": "AlertRuleConfigSchema",
"description": "Schema for the alert rule."
},
"AlertRuleCreationSchema": {
"properties": {
"condition": {
"$ref": "#/components/schemas/Condition"
},
"alert_severity": {
"allOf": [
{
"$ref": "#/components/schemas/AlertSeverity"
}
],
"default": "medium"
},
"is_active": {
"type": "boolean",
"title": "Is Active",
"default": true
}
},
"type": "object",
"required": [
"condition"
],
"title": "AlertRuleCreationSchema",
"description": "Schema defines the parameters for creating new alert rule."
},
"AlertRuleInfoSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"monitor_id": {
"type": "integer",
"title": "Monitor Id"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"model_id": {
"type": "integer",
"title": "Model Id"
},
"alerts_count": {
"type": "integer",
"title": "Alerts Count",
"default": 0
},
"max_end_time": {
"type": "string",
"format": "date-time",
"title": "Max End Time"
}
},
"type": "object",
"required": [
"id",
"monitor_id",
"condition",
"is_active",
"model_id"
],
"title": "AlertRuleInfoSchema",
"description": "Schema of alert rule info for display."
},
"AlertRuleSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"monitor_id": {
"type": "integer",
"title": "Monitor Id"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
}
},
"type": "object",
"required": [
"id",
"monitor_id",
"condition",
"is_active"
],
"title": "AlertRuleSchema",
"description": "Schema for the alert rule."
},
"AlertRuleType": {
"type": "string",
"enum": [
"sample_count",
"label_count",
"label_ratio"
],
"title": "AlertRuleType",
"description": "An enumeration."
},
"AlertRuleUpdateSchema": {
"properties": {
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
}
},
"type": "object",
"title": "AlertRuleUpdateSchema",
"description": "Schema defines the parameters for updating alert rule."
},
"AlertSchema": {
"properties": {
"alert_rule_id": {
"type": "integer",
"title": "Alert Rule Id"
},
"failed_values": {
"additionalProperties": {
"additionalProperties": {
"type": "number"
},
"type": "object"
},
"type": "object",
"title": "Failed Values"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"resolved": {
"type": "boolean",
"title": "Resolved"
},
"id": {
"type": "integer",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
}
},
"type": "object",
"required": [
"alert_rule_id",
"failed_values",
"start_time",
"end_time",
"resolved",
"id",
"created_at"
],
"title": "AlertSchema",
"description": "Schema for the alert."
},
"AlertSeverity": {
"type": "string",
"enum": [
"low",
"medium",
"high",
"critical"
],
"title": "AlertSeverity",
"description": "Enum for the alert severity."
},
"AlertWebhookSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"kind": {
"$ref": "#/components/schemas/WebhookKind"
},
"http_url": {
"type": "string",
"maxLength": 65536,
"minLength": 1,
"format": "uri",
"title": "Http Url"
},
"http_method": {
"$ref": "#/components/schemas/WebhookHttpMethod"
},
"http_headers": {
"type": "object",
"title": "Http Headers"
},
"notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"additional_arguments": {
"type": "object",
"title": "Additional Arguments"
},
"latest_execution_date": {
"type": "string",
"format": "date-time",
"title": "Latest Execution Date"
},
"latest_execution_status": {
"type": "object",
"title": "Latest Execution Status"
}
},
"type": "object",
"required": [
"id",
"name",
"kind",
"http_url",
"http_method",
"http_headers",
"notification_levels",
"additional_arguments"
],
"title": "AlertWebhookSchema",
"description": "Alert webhook schema."
},
"AutoFrequencyResponse": {
"properties": {
"frequency": {
"$ref": "#/components/schemas/Frequency"
},
"start": {
"type": "integer",
"title": "Start"
},
"end": {
"type": "integer",
"title": "End"
}
},
"type": "object",
"required": [
"frequency",
"start",
"end"
],
"title": "AutoFrequencyResponse",
"description": "Response for auto frequency."
},
"BasicUserSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"email": {
"type": "string",
"title": "Email"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"full_name": {
"type": "string",
"title": "Full Name"
},
"picture_url": {
"type": "string",
"title": "Picture Url"
},
"organization": {
"$ref": "#/components/schemas/deepchecks_monitoring__api__v1__global_api__users__OrganizationSchema"
}
},
"type": "object",
"required": [
"id",
"email",
"created_at"
],
"title": "BasicUserSchema",
"description": "Schema for user."
},
"BatchModelMemberUpdateSchema": {
"properties": {
"user_ids": {
"items": {
"type": "integer"
},
"type": "array",
"title": "User Ids"
},
"replace": {
"type": "boolean",
"title": "Replace",
"default": true
}
},
"type": "object",
"required": [
"user_ids"
],
"title": "BatchModelMemberUpdateSchema",
"description": "Member update schema."
},
"Body_save_reference_api_v1_model_versions__model_version_id__reference_post": {
"properties": {
"batch": {
"type": "string",
"format": "binary",
"title": "Batch"
}
},
"type": "object",
"required": [
"batch"
],
"title": "Body_save_reference_api_v1_model_versions__model_version_id__reference_post"
},
"CheckConfigSchema": {
"properties": {
"module_name": {
"type": "string",
"title": "Module Name"
},
"class_name": {
"type": "string",
"title": "Class Name"
},
"params": {
"type": "object",
"title": "Params"
}
},
"type": "object",
"required": [
"module_name",
"class_name",
"params"
],
"title": "CheckConfigSchema"
},
"CheckCreationSchema": {
"properties": {
"config": {
"$ref": "#/components/schemas/CheckConfigSchema"
},
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
}
},
"type": "object",
"required": [
"config"
],
"title": "CheckCreationSchema",
"description": "Check schema."
},
"CheckGroupBySchema": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"nullable": true
},
"value": {
"type": "object",
"title": "Value"
},
"count": {
"type": "integer",
"title": "Count"
},
"filters": {
"$ref": "#/components/schemas/DataFilterList"
}
},
"type": "object",
"required": [
"count",
"filters"
],
"title": "CheckGroupBySchema",
"description": "Schema for result of a check group by run."
},
"CheckNotebookSchema": {
"properties": {
"filter": {
"$ref": "#/components/schemas/DataFilterList"
},
"end_time": {
"type": "string",
"title": "End Time"
},
"start_time": {
"type": "string",
"title": "Start Time"
},
"additional_kwargs": {
"$ref": "#/components/schemas/MonitorCheckConfSchema"
},
"model_version_id": {
"type": "integer",
"title": "Model Version Id"
},
"as_script": {
"type": "boolean",
"title": "As Script",
"default": false
}
},
"type": "object",
"required": [
"end_time",
"start_time"
],
"title": "CheckNotebookSchema",
"description": "Schema to get a check script/notebook."
},
"CheckResultSchema": {
"properties": {
"output": {
"type": "object",
"title": "Output"
},
"time_labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Time Labels"
}
},
"type": "object",
"required": [
"output",
"time_labels"
],
"title": "CheckResultSchema",
"description": "Check run result schema."
},
"CheckRunOptions": {
"properties": {
"filter": {
"$ref": "#/components/schemas/DataFilterList"
},
"additional_kwargs": {
"$ref": "#/components/schemas/MonitorCheckConfSchema"
}
},
"type": "object",
"title": "CheckRunOptions",
"description": "Basic schema for running a check."
},
"CheckSchema": {
"properties": {
"config": {
"$ref": "#/components/schemas/CheckConfigSchema"
},
"model_id": {
"type": "integer",
"title": "Model Id"
},
"id": {
"type": "integer",
"title": "Id"
},
"docs_link": {
"type": "string",
"title": "Docs Link",
"nullable": true
},
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
}
},
"type": "object",
"required": [
"config",
"model_id",
"id"
],
"title": "CheckSchema",
"description": "Schema for the check."
},
"ColumnMetadata": {
"properties": {
"type": {
"$ref": "#/components/schemas/ColumnType"
},
"stats": {
"$ref": "#/components/schemas/ColumnStatistics"
}
},
"type": "object",
"required": [
"type",
"stats"
],
"title": "ColumnMetadata",
"description": "TypedDict containing relevant column metadata."
},
"ColumnStatistics": {
"properties": {
"max": {
"type": "number",
"title": "Max"
},
"min": {
"type": "number",
"title": "Min"
},
"values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Values"
}
},
"type": "object",
"title": "ColumnStatistics",
"description": "A typed object represents a numeric column statistic."
},
"ColumnType": {
"type": "string",
"enum": [
"numeric",
"integer",
"bigint",
"categorical",
"boolean",
"text",
"array_float",
"array_float_2d",
"datetime"
],
"title": "ColumnType",
"description": "Enum containing possible types of data."
},
"CompleteDetailsSchema": {
"properties": {
"invitation": {
"$ref": "#/components/schemas/InvitationInfoSchema"
},
"user_full_name": {
"type": "string",
"title": "User Full Name"
},
"organization_name": {
"type": "string",
"title": "Organization Name"
}
},
"type": "object",
"title": "CompleteDetailsSchema",
"description": "Schema for complete details page."
},
"CompleteDetailsUpdateSchema": {
"properties": {
"new_organization_name": {
"type": "string",
"title": "New Organization Name"
},
"user_full_name": {
"type": "string",
"title": "User Full Name"
},
"accept_invite": {
"type": "boolean",
"title": "Accept Invite"
}
},
"type": "object",
"title": "CompleteDetailsUpdateSchema",
"description": "Schema for to update complete details page."
},
"Condition": {
"properties": {
"operator": {
"$ref": "#/components/schemas/OperatorsEnum"
},
"value": {
"type": "number",
"title": "Value"
}
},
"type": "object",
"required": [
"operator",
"value"
],
"title": "Condition",
"description": "Condition to define an alert on check result, value must be numeric."
},
"ConnectedModelSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"task_type": {
"$ref": "#/components/schemas/TaskType"
},
"n_of_alerts": {
"type": "integer",
"title": "N Of Alerts"
},
"n_of_pending_rows": {
"type": "integer",
"title": "N Of Pending Rows"
},
"n_of_updating_versions": {
"type": "integer",
"title": "N Of Updating Versions"
},
"latest_update": {
"type": "string",
"format": "date-time",
"title": "Latest Update"
},
"sample_count": {
"type": "integer",
"title": "Sample Count"
},
"label_count": {
"type": "integer",
"title": "Label Count"
},
"label_ratio": {
"type": "number",
"title": "Label Ratio"
}
},
"type": "object",
"required": [
"id",
"name",
"n_of_alerts",
"n_of_pending_rows",
"n_of_updating_versions",
"sample_count",
"label_count",
"label_ratio"
],
"title": "ConnectedModelSchema",
"description": "Model schema for the \"Connected Models\" screen."
},
"ConnectedModelVersionSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"last_update_time": {
"type": "string",
"format": "date-time",
"title": "Last Update Time"
},
"n_of_pending_rows": {
"type": "integer",
"title": "N Of Pending Rows"
},
"n_of_alerts": {
"type": "integer",
"title": "N Of Alerts"
}
},
"type": "object",
"required": [
"id",
"name",
"n_of_pending_rows",
"n_of_alerts"
],
"title": "ConnectedModelVersionSchema",
"description": "ModelVersion schema for the \"Connected Models\" screen."
},
"DashboardSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
},
"monitors": {
"items": {
"$ref": "#/components/schemas/MonitorSchema"
},
"type": "array",
"title": "Monitors"
}
},
"type": "object",
"required": [
"id",
"monitors"
],
"title": "DashboardSchema",
"description": "Schema for the dashboard."
},
"DashboardUpdateSchema": {
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "DashboardUpdateSchema",
"description": "Schema defines the parameters for updating a dashboard."
},
"DataFilter": {
"properties": {
"column": {
"type": "string",
"title": "Column"
},
"operator": {
"$ref": "#/components/schemas/OperatorsEnum"
},
"value": {
"title": "Value"
}
},
"type": "object",
"required": [
"column",
"operator"
],
"title": "DataFilter",
"description": "Filter to be used on data, column can be feature/non-feature and value can be numeric/string."
},
"DataFilterList": {
"properties": {
"filters": {
"items": {
"$ref": "#/components/schemas/DataFilter"
},
"type": "array",
"title": "Filters"
}
},
"type": "object",
"required": [
"filters"
],
"title": "DataFilterList",
"description": "List of data filters."
},
"DataIngestionAlertRuleCreationSchema": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
},
"alert_type": {
"$ref": "#/components/schemas/AlertRuleType"
},
"frequency": {
"$ref": "#/components/schemas/Frequency"
}
},
"type": "object",
"required": [
"name",
"condition",
"alert_type",
"frequency"
],
"title": "DataIngestionAlertRuleCreationSchema",
"description": "Schema defines the parameters for creating new alert rule."
},
"DataIngestionAlertRuleSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"model_id": {
"type": "integer",
"title": "Model Id"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
}
},
"type": "object",
"required": [
"id",
"name",
"model_id",
"condition",
"is_active"
],
"title": "DataIngestionAlertRuleSchema",
"description": "Schema for the alert rule."
},
"DataIngestionAlertRuleUpdateSchema": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"alert_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"condition": {
"$ref": "#/components/schemas/Condition"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
}
},
"type": "object",
"title": "DataIngestionAlertRuleUpdateSchema",
"description": "Schema defines the parameters for updating alert rule."
},
"DataIngestionAlertSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"alert_rule_id": {
"type": "integer",
"title": "Alert Rule Id"
},
"value": {
"type": "number",
"title": "Value"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"resolved": {
"type": "boolean",
"title": "Resolved"
}
},
"type": "object",
"required": [
"id",
"created_at",
"alert_rule_id",
"value",
"start_time",
"end_time",
"resolved"
],
"title": "DataIngestionAlertSchema",
"description": "Schema for the alert."
},
"DataSourceCreationSchema": {
"properties": {
"type": {
"type": "string",
"title": "Type"
},
"parameters": {
"type": "object",
"title": "Parameters"
}
},
"type": "object",
"required": [
"type",
"parameters"
],
"title": "DataSourceCreationSchema",
"description": "Data Source creation schema."
},
"DataSourceSchema": {
"properties": {
"type": {
"type": "string",
"title": "Type"
},
"parameters": {
"type": "object",
"title": "Parameters"
},
"id": {
"type": "integer",
"title": "Id"
}
},
"type": "object",
"required": [
"type",
"parameters",
"id"
],
"title": "DataSourceSchema",
"description": "Data Source schema."
},
"FeaturesSchema": {
"properties": {
"max_models": {
"type": "integer",
"title": "Max Models"
},
"signup_enabled": {
"type": "boolean",
"title": "Signup Enabled"
},
"slack_enabled": {
"type": "boolean",
"title": "Slack Enabled"
},
"rows_per_minute": {
"type": "integer",
"title": "Rows Per Minute"
},
"custom_checks_enabled": {
"type": "boolean",
"title": "Custom Checks Enabled"
},
"data_retention_months": {
"type": "integer",
"title": "Data Retention Months"
},
"monthly_predictions_limit": {
"type": "integer",
"title": "Monthly Predictions Limit"
},
"sso_enabled": {
"type": "boolean",
"title": "Sso Enabled"
},
"onboarding_enabled": {
"type": "boolean",
"title": "Onboarding Enabled"
},
"update_roles": {
"type": "boolean",
"title": "Update Roles"
},
"model_assignment": {
"type": "boolean",
"title": "Model Assignment"
},
"email_enabled": {
"type": "boolean",
"title": "Email Enabled"
}
},
"type": "object",
"required": [
"max_models",
"signup_enabled",
"slack_enabled",
"rows_per_minute",
"custom_checks_enabled",
"data_retention_months",
"monthly_predictions_limit",
"sso_enabled",
"onboarding_enabled",
"update_roles",
"model_assignment",
"email_enabled"
],
"title": "FeaturesSchema",
"description": "Schema to be returned to the client for the features control."
},
"Frequency": {
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH"
],
"title": "Frequency",
"description": "Monitor execution frequency."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdResponse": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "IdResponse",
"description": "Schema defines a response containing only id."
},
"IdentifierKind": {
"enum": [
"id",
"name"
],
"title": "IdentifierKind",
"description": "Identifier kind."
},
"IngestionErrorSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"sample_id": {
"type": "string",
"title": "Sample Id"
},
"error": {
"type": "string",
"title": "Error"
},
"sample": {
"type": "string",
"title": "Sample"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"model_version_id": {
"type": "integer",
"title": "Model Version Id"
}
},
"type": "object",
"required": [
"id",
"created_at"
],
"title": "IngestionErrorSchema",
"description": "IngestionError output schema."
},
"IngestionErrorsSortKey": {
"type": "string",
"enum": [
"timestamp",
"error"
],
"title": "IngestionErrorsSortKey",
"description": "Sort key of ingestion errors output."
},
"InvitationCreationSchema": {
"properties": {
"email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"items": {
"type": "string",
"format": "email"
},
"type": "array"
}
],
"title": "Email"
},
"ttl": {
"type": "integer",
"title": "Ttl"
}
},
"type": "object",
"required": [
"email"
],
"title": "InvitationCreationSchema",
"description": "Schema for the invitation creation."
},
"InvitationInfoSchema": {
"properties": {
"from_user": {
"type": "string",
"title": "From User"
},
"org_name": {
"type": "string",
"title": "Org Name"
}
},
"type": "object",
"required": [
"from_user",
"org_name"
],
"title": "InvitationInfoSchema",
"description": "Schema for info on invitation."
},
"MemberSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"email": {
"type": "string",
"title": "Email"
},
"full_name": {
"type": "string",
"title": "Full Name"
},
"disabled": {
"type": "boolean",
"title": "Disabled"
},
"picture_url": {
"type": "string",
"title": "Picture Url"
},
"last_login": {
"type": "string",
"format": "date-time",
"title": "Last Login"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RoleEnum"
},
"type": "array"
}
},
"type": "object",
"required": [
"id",
"email",
"disabled",
"created_at",
"roles"
],
"title": "MemberSchema",
"description": "Schema for a member."
},
"MemberUpdateSchema": {
"properties": {
"models": {
"items": {
"$ref": "#/components/schemas/deepchecks_monitoring__ee__api__v1__members__IdNotifySchema"
},
"type": "array",
"title": "Models"
},
"replace": {
"type": "boolean",
"title": "Replace",
"default": true
}
},
"type": "object",
"required": [
"models"
],
"title": "MemberUpdateSchema",
"description": "Member update schema."
},
"ModelCreationSchema": {
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
},
"description": {
"type": "string",
"maxLength": 200,
"title": "Description"
},
"task_type": {
"$ref": "#/components/schemas/TaskType"
},
"alerts_delay_labels_ratio": {
"type": "number",
"title": "Alerts Delay Labels Ratio"
},
"alerts_delay_seconds": {
"type": "integer",
"title": "Alerts Delay Seconds"
},
"notes": {
"items": {
"$ref": "#/components/schemas/ModelNoteCreationSchema"
},
"type": "array",
"title": "Notes"
},
"obj_store_path": {
"type": "string",
"title": "Obj Store Path"
}
},
"type": "object",
"required": [
"name",
"task_type",
"alerts_delay_labels_ratio",
"alerts_delay_seconds"
],
"title": "ModelCreationSchema",
"description": "Model schema."
},
"ModelDailyIngestion": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"label_count": {
"type": "integer",
"title": "Label Count"
},
"timestamp": {
"type": "integer",
"title": "Timestamp"
}
},
"type": "object",
"required": [
"count",
"label_count",
"timestamp"
],
"title": "ModelDailyIngestion"
},
"ModelManagmentSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"alerts_count": {
"type": "integer",
"title": "Alerts Count"
},
"monitors_count": {
"type": "integer",
"title": "Monitors Count"
},
"latest_time": {
"type": "integer",
"title": "Latest Time"
},
"start_time": {
"type": "integer",
"title": "Start Time"
},
"description": {
"type": "string",
"title": "Description"
},
"task_type": {
"$ref": "#/components/schemas/TaskType"
},
"has_data": {
"type": "boolean",
"title": "Has Data",
"default": false
},
"max_severity": {
"$ref": "#/components/schemas/AlertSeverity"
},
"versions": {
"items": {
"$ref": "#/components/schemas/ModelVersionManagmentSchema"
},
"type": "array",
"title": "Versions"
},
"members": {
"items": {
"$ref": "#/components/schemas/deepchecks_monitoring__api__v1__model__IdNotifySchema"
},
"type": "array",
"title": "Members"
},
"severities_count": {
"additionalProperties": {
"type": "integer"
},
"type": "object",
"title": "Severities Count"
}
},
"type": "object",
"required": [
"id",
"name",
"alerts_count",
"monitors_count",
"versions",
"members",
"severities_count"
],
"title": "ModelManagmentSchema",
"description": "Model schema for the \"Model managment\" screen."
},
"ModelNoteCreationSchema": {
"properties": {
"title": {
"type": "string",
"title": "Title"
},
"text": {
"type": "string",
"title": "Text"
}
},
"type": "object",
"required": [
"title"
],
"title": "ModelNoteCreationSchema",
"description": "Note schema."
},
"ModelNoteSchema": {
"properties": {
"title": {
"type": "string",
"title": "Title"
},
"text": {
"type": "string",
"title": "Text"
},
"id": {
"type": "string",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"model_id": {
"type": "integer",
"title": "Model Id"
}
},
"type": "object",
"required": [
"title",
"id",
"created_at",
"model_id"
],
"title": "ModelNoteSchema",
"description": "Note schema."
},
"ModelScheduleTimeSchema": {
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp"
}
},
"type": "object",
"required": [
"timestamp"
],
"title": "ModelScheduleTimeSchema",
"description": "Model Schedule Time Schema."
},
"ModelSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
},
"description": {
"type": "string",
"maxLength": 200,
"title": "Description"
},
"task_type": {
"$ref": "#/components/schemas/TaskType"
},
"alerts_delay_labels_ratio": {
"type": "number",
"title": "Alerts Delay Labels Ratio"
},
"alerts_delay_seconds": {
"type": "integer",
"title": "Alerts Delay Seconds"
},
"obj_store_path": {
"type": "string",
"title": "Obj Store Path"
}
},
"type": "object",
"required": [
"id",
"name",
"alerts_delay_labels_ratio",
"alerts_delay_seconds"
],
"title": "ModelSchema",
"description": "Model Schema."
},
"ModelVersionCreationSchema": {
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"title": "Name"
},
"features": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnType"
},
"type": "object"
},
"additional_data": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnType"
},
"type": "object"
},
"feature_importance": {
"additionalProperties": {
"type": "number"
},
"type": "object",
"title": "Feature Importance"
},
"classes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Classes"
},
"label_map": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Label Map"
}
},
"type": "object",
"required": [
"name",
"features",
"additional_data"
],
"title": "ModelVersionCreationSchema",
"description": "Schema defines the parameters for creating new model version."
},
"ModelVersionManagmentSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"model_id": {
"type": "integer",
"title": "Model Id"
},
"name": {
"type": "string",
"title": "Name"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
}
},
"type": "object",
"required": [
"id",
"model_id",
"name",
"start_time",
"end_time"
],
"title": "ModelVersionManagmentSchema",
"description": "ModelVersion schema for the \"Model managment\" screen."
},
"ModelVersionSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"model_id": {
"type": "integer",
"title": "Model Id"
},
"name": {
"type": "string",
"title": "Name"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"features_columns": {
"type": "object",
"title": "Features Columns"
},
"additional_data_columns": {
"type": "object",
"title": "Additional Data Columns"
},
"model_columns": {
"type": "object",
"title": "Model Columns"
},
"meta_columns": {
"type": "object",
"title": "Meta Columns"
},
"feature_importance": {
"type": "object",
"title": "Feature Importance"
},
"statistics": {
"type": "object",
"title": "Statistics"
},
"classes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Classes"
},
"label_map": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Label Map"
},
"balance_classes": {
"type": "boolean",
"title": "Balance Classes"
}
},
"type": "object",
"required": [
"id",
"model_id",
"name",
"start_time",
"end_time",
"features_columns",
"additional_data_columns",
"model_columns",
"meta_columns",
"balance_classes"
],
"title": "ModelVersionSchema",
"description": "Model version schema."
},
"ModelVersionUpdateSchema": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"feature_importance": {
"additionalProperties": {
"type": "number"
},
"type": "object",
"title": "Feature Importance"
}
},
"type": "object",
"title": "ModelVersionUpdateSchema",
"description": "ModelVersion update schema."
},
"MonitorCheckConf": {
"properties": {
"check_conf": {
"items": {
"$ref": "#/components/schemas/MonitorTypeConf"
},
"type": "array",
"title": "Check Conf"
},
"res_conf": {
"$ref": "#/components/schemas/MonitorTypeConf"
}
},
"type": "object",
"title": "MonitorCheckConf",
"description": "List of data filters."
},
"MonitorCheckConfSchema": {
"properties": {
"check_conf": {
"additionalProperties": {
"items": {
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1
},
"type": "object",
"title": "Check Conf"
},
"res_conf": {
"items": {
"type": "string",
"minLength": 1
},
"type": "array",
"minItems": 1,
"title": "Res Conf"
}
},
"type": "object",
"required": [
"check_conf"
],
"title": "MonitorCheckConfSchema",
"description": "List of data filters."
},
"MonitorCreationSchema": {
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
},
"lookback": {
"type": "integer",
"minimum": 0,
"title": "Lookback"
},
"aggregation_window": {
"type": "integer",
"minimum": 0,
"title": "Aggregation Window"
},
"frequency": {
"$ref": "#/components/schemas/Frequency"
},
"dashboard_id": {
"type": "integer",
"title": "Dashboard Id",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200,
"title": "Description"
},
"data_filters": {
"allOf": [
{
"$ref": "#/components/schemas/DataFilterList"
}
],
"title": "Data Filters",
"nullable": true
},
"additional_kwargs": {
"allOf": [
{
"$ref": "#/components/schemas/MonitorCheckConfSchema"
}
],
"title": "Additional Kwargs",
"nullable": true
}
},
"type": "object",
"required": [
"name",
"lookback",
"aggregation_window",
"frequency"
],
"title": "MonitorCreationSchema",
"description": "Schema defines the parameters for creating new monitor."
},
"MonitorNotebookSchema": {
"properties": {
"end_time": {
"type": "string",
"title": "End Time"
},
"start_time": {
"type": "string",
"title": "Start Time"
},
"model_version_id": {
"type": "integer",
"title": "Model Version Id"
},
"as_script": {
"type": "boolean",
"title": "As Script",
"default": false
}
},
"type": "object",
"required": [
"end_time",
"start_time"
],
"title": "MonitorNotebookSchema",
"description": "Schema to get a monitor script/notebook."
},
"MonitorOptions": {
"properties": {
"filter": {
"$ref": "#/components/schemas/DataFilterList"
},
"end_time": {
"type": "string",
"title": "End Time"
},
"start_time": {
"type": "string",
"title": "Start Time"
},
"additional_kwargs": {
"$ref": "#/components/schemas/MonitorCheckConfSchema"
},
"frequency": {
"$ref": "#/components/schemas/Frequency"
},
"aggregation_window": {
"type": "integer",
"title": "Aggregation Window",
"default": 1
}
},
"type": "object",
"required": [
"end_time",
"start_time"
],
"title": "MonitorOptions",
"description": "Add to single window monitor options frequency and aggregation window to make it multi window."
},
"MonitorRunSchema": {
"properties": {
"end_time": {
"type": "string",
"title": "End Time"
}
},
"type": "object",
"title": "MonitorRunSchema",
"description": "Schema defines the parameters for creating new monitor."
},
"MonitorSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
},
"check": {
"$ref": "#/components/schemas/CheckSchema"
},
"dashboard_id": {
"type": "integer",
"title": "Dashboard Id",
"nullable": true
},
"lookback": {
"type": "integer",
"title": "Lookback"
},
"aggregation_window": {
"type": "integer",
"title": "Aggregation Window"
},
"description": {
"type": "string",
"maxLength": 200,
"title": "Description"
},
"data_filters": {
"$ref": "#/components/schemas/DataFilterList"
},
"additional_kwargs": {
"$ref": "#/components/schemas/MonitorCheckConfSchema"
},
"alert_rules": {
"items": {
"$ref": "#/components/schemas/AlertRuleSchema"
},
"type": "array",
"title": "Alert Rules"
},
"frequency": {
"$ref": "#/components/schemas/Frequency"
}
},
"type": "object",
"required": [
"id",
"name",
"check",
"lookback",
"aggregation_window",
"alert_rules",
"frequency"
],
"title": "MonitorSchema",
"description": "Schema for the monitor."
},
"MonitorTypeConf": {
"properties": {
"type": {
"type": "string",
"title": "Type"
},
"values": {
"items": {
"$ref": "#/components/schemas/MonitorValueConf"
},
"type": "array",
"title": "Values"
},
"is_agg_shown": {
"type": "boolean",
"title": "Is Agg Shown"
}
},
"type": "object",
"required": [
"type"
],
"title": "MonitorTypeConf",
"description": "List of data filters."
},
"MonitorUpdateSchema": {
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"title": "Name"
},
"lookback": {
"type": "integer",
"title": "Lookback"
},
"description": {
"type": "string",
"maxLength": 200,
"title": "Description"
},
"data_filters": {
"allOf": [
{
"$ref": "#/components/schemas/DataFilterList"
}
],
"title": "Data Filters",
"nullable": true
},
"dashboard_id": {
"type": "integer",
"title": "Dashboard Id",
"nullable": true
},
"additional_kwargs": {
"allOf": [
{
"$ref": "#/components/schemas/MonitorCheckConfSchema"
}
],
"title": "Additional Kwargs",
"nullable": true
},
"frequency": {
"$ref": "#/components/schemas/Frequency"
},
"aggregation_window": {
"type": "integer",
"title": "Aggregation Window"
}
},
"type": "object",
"title": "MonitorUpdateSchema",
"description": "Schema defines the parameters for creating new monitor."
},
"MonitorValueConf": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"is_agg": {
"type": "boolean",
"title": "Is Agg"
}
},
"type": "object",
"required": [
"name"
],
"title": "MonitorValueConf",
"description": "List of data filters."
},
"NameIdResponse": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "NameIdResponse",
"description": "Schema defines a response containing only id and name."
},
"OperatorsEnum": {
"type": "string",
"enum": [
"greater_than_equals",
"greater_than",
"less_than_equals",
"less_than",
"equals",
"not_equals",
"in"
],
"title": "OperatorsEnum",
"description": "Operators for numeric and categorical filters."
},
"OrgTier": {
"type": "string",
"enum": [
"FREE",
"BASIC",
"SCALE",
"DEDICATED"
],
"title": "OrgTier",
"description": "Organization tier."
},
"OrganizationUpdateSchema": {
"properties": {
"slack_notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"email_notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"webhook_notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
}
},
"type": "object",
"title": "OrganizationUpdateSchema",
"description": "Schema for the organization update."
},
"PagerDutyWebhookProperties": {
"properties": {
"kind": {
"type": "string",
"enum": [
"PAGER_DUTY"
],
"title": "Kind",
"default": "PAGER_DUTY"
},
"http_url": {
"type": "string",
"maxLength": 65536,
"minLength": 1,
"format": "uri",
"title": "Http Url",
"default": "https://events.pagerduty.com/v2/enqueue"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"api_access_key": {
"type": "string",
"title": "Api Access Key"
},
"event_routing_key": {
"type": "string",
"title": "Event Routing Key"
},
"event_group": {
"type": "string",
"title": "Event Group",
"default": "deepchecks"
},
"event_class": {
"type": "string",
"title": "Event Class",
"default": ""
}
},
"type": "object",
"required": [
"name",
"description",
"event_routing_key"
],
"title": "PagerDutyWebhookProperties",
"description": "PagerDuty service webhook initialization properties."
},
"PartialPagerDutyWebhookProperties": {
"properties": {
"kind": {
"type": "string",
"enum": [
"PAGER_DUTY"
],
"title": "Kind",
"default": "PAGER_DUTY"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"api_access_key": {
"type": "string",
"title": "Api Access Key"
},
"event_routing_key": {
"type": "string",
"title": "Event Routing Key"
},
"event_group": {
"type": "string",
"title": "Event Group"
},
"event_class": {
"type": "string",
"title": "Event Class"
}
},
"type": "object",
"title": "PartialPagerDutyWebhookProperties",
"description": "PagerDuty service webhook properties."
},
"PartialStandardWebhookProperties": {
"properties": {
"kind": {
"type": "string",
"enum": [
"STANDARD"
],
"title": "Kind",
"default": "STANDARD"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"http_url": {
"type": "string",
"maxLength": 65536,
"minLength": 1,
"format": "uri",
"title": "Http Url"
},
"http_method": {
"$ref": "#/components/schemas/WebhookHttpMethod"
},
"http_headers": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Http Headers"
},
"notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
}
},
"type": "object",
"title": "PartialStandardWebhookProperties",
"description": "Standard webhook properties."
},
"RoleEnum": {
"type": "string",
"enum": [
"admin",
"owner"
],
"title": "RoleEnum",
"description": "Roles enum."
},
"RoleUpdateSchema": {
"properties": {
"roles": {
"items": {
"$ref": "#/components/schemas/RoleEnum"
},
"type": "array"
},
"replace": {
"type": "boolean",
"title": "Replace",
"default": true
}
},
"type": "object",
"required": [
"roles"
],
"title": "RoleUpdateSchema",
"description": "Role update schema."
},
"SingleCheckRunOptions": {
"properties": {
"filter": {
"$ref": "#/components/schemas/DataFilterList"
},
"end_time": {
"type": "string",
"title": "End Time"
},
"start_time": {
"type": "string",
"title": "Start Time"
},
"additional_kwargs": {
"$ref": "#/components/schemas/MonitorCheckConfSchema"
}
},
"type": "object",
"required": [
"end_time",
"start_time"
],
"title": "SingleCheckRunOptions",
"description": "Options for running check on a specific window."
},
"SortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortOrder",
"description": "Sort order of ingestion errors output."
},
"StandardWebhookProperties": {
"properties": {
"kind": {
"type": "string",
"enum": [
"STANDARD"
],
"title": "Kind",
"default": "STANDARD"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"http_url": {
"type": "string",
"maxLength": 65536,
"minLength": 1,
"format": "uri",
"title": "Http Url"
},
"http_method": {
"$ref": "#/components/schemas/WebhookHttpMethod"
},
"http_headers": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Http Headers"
},
"notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
}
},
"type": "object",
"required": [
"name",
"http_url",
"http_method"
],
"title": "StandardWebhookProperties",
"description": "Standard webhook initialization properties."
},
"Step": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"title": "Step",
"description": "Sort order of ingestion errors output."
},
"StepSchema": {
"properties": {
"step": {
"$ref": "#/components/schemas/Step"
}
},
"type": "object",
"required": [
"step"
],
"title": "StepSchema",
"description": "Schema for onboarding steps."
},
"TableDataSchema": {
"properties": {
"filter": {
"$ref": "#/components/schemas/DataFilterList"
},
"rows_count": {
"type": "integer",
"maximum": 100000,
"title": "Rows Count",
"default": 100
}
},
"type": "object",
"title": "TableDataSchema",
"description": "Class for selecting a specific amount of rows on a table data."
},
"TaskType": {
"enum": [
"regression",
"binary",
"multiclass"
],
"title": "TaskType",
"description": "Enum containing supported task types."
},
"TimeWindowOutputStatsSchema": {
"properties": {
"num_labeled_samples": {
"type": "integer",
"title": "Num Labeled Samples"
},
"num_samples": {
"type": "integer",
"title": "Num Samples"
}
},
"type": "object",
"title": "TimeWindowOutputStatsSchema",
"description": "Monitor run schema."
},
"TimeWindowSchema": {
"properties": {
"end_time": {
"type": "string",
"title": "End Time"
},
"start_time": {
"type": "string",
"title": "Start Time"
}
},
"type": "object",
"title": "TimeWindowSchema",
"description": "Monitor run schema."
},
"UserSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"email": {
"type": "string",
"title": "Email"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"full_name": {
"type": "string",
"title": "Full Name"
},
"picture_url": {
"type": "string",
"title": "Picture Url"
},
"organization": {
"$ref": "#/components/schemas/deepchecks_monitoring__api__v1__global_api__users__OrganizationSchema"
},
"roles": {
"items": {
"$ref": "#/components/schemas/RoleEnum"
},
"type": "array"
}
},
"type": "object",
"required": [
"id",
"email",
"created_at",
"roles"
],
"title": "UserSchema",
"description": "Schema for user with roles."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WebhookHttpMethod": {
"type": "string",
"enum": [
"GET",
"POST"
],
"title": "WebhookHttpMethod",
"description": "HTTP method used by webhook."
},
"WebhookKind": {
"type": "string",
"enum": [
"STANDARD",
"PAGER_DUTY"
],
"title": "WebhookKind",
"description": "Kind of request payload that webhook will form."
},
"WindowDataSchema": {
"properties": {
"filter": {
"$ref": "#/components/schemas/DataFilterList"
},
"end_time": {
"type": "string",
"title": "End Time"
},
"start_time": {
"type": "string",
"title": "Start Time"
},
"rows_count": {
"type": "integer",
"maximum": 100000,
"title": "Rows Count",
"default": 100
}
},
"type": "object",
"required": [
"end_time",
"start_time"
],
"title": "WindowDataSchema",
"description": "Schema for getting rows in a specific window."
},
"deepchecks_monitoring__api__v1__global_api__organization__OrganizationSchema": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"is_slack_connected": {
"type": "boolean",
"title": "Is Slack Connected"
},
"is_webhook_connected": {
"type": "boolean",
"title": "Is Webhook Connected"
},
"slack_notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"email_notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
},
"webhook_notification_levels": {
"items": {
"$ref": "#/components/schemas/AlertSeverity"
},
"type": "array"
}
},
"type": "object",
"required": [
"name",
"is_slack_connected",
"is_webhook_connected",
"slack_notification_levels",
"email_notification_levels",
"webhook_notification_levels"
],
"title": "OrganizationSchema",
"description": "Schema for the organization."
},
"deepchecks_monitoring__api__v1__global_api__users__OrganizationSchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"tier": {
"$ref": "#/components/schemas/OrgTier"
}
},
"type": "object",
"required": [
"id",
"name",
"tier"
],
"title": "OrganizationSchema",
"description": "Schema for organization."
},
"deepchecks_monitoring__api__v1__model__IdNotifySchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"notify": {
"type": "boolean",
"title": "Notify"
}
},
"type": "object",
"required": [
"id",
"notify"
],
"title": "IdNotifySchema"
},
"deepchecks_monitoring__ee__api__v1__members__IdNotifySchema": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"notify": {
"type": "boolean",
"title": "Notify"
}
},
"type": "object",
"required": [
"id",
"notify"
],
"title": "IdNotifySchema"
}
},
"securitySchemes": {
"AccessBearer": {
"type": "oauth2",
"flows": {
"password": {
"scopes": {},
"tokenUrl": "/token"
}
}
}
}
},
"tags": [
{
"name": "Models",
"description": "APIs for interacting with model entities."
},
{
"name": "Checks",
"description": "APIs for interacting with check entities. Includes adding/updating checks, and retrieving check results."
},
{
"name": "Monitors",
"description": "APIs for interacting with monitor entities. Includes adding/updating monitors within a dashboard, getting dasbboard data, and retrieving monitor results."
},
{
"name": "Alerts",
"description": "APIs for interacting with alert/alert-rule entities. Includes adding/updating alert-rules, and retrieving/counting active alerts results."
},
{
"name": "Data",
"description": "APIs for sending data to the deepchecks_monitoring service."
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment