From 67378bd193196d79caf90ce54dc8352a96e9b1b2 Mon Sep 17 00:00:00 2001 From: ReaperOfVeriod Date: Sun, 25 Oct 2026 06:18:40 +0100 Subject: [PATCH] Document overlay alert settings contract --- contracts/v1/overlay-response.json | 7 +++++-- fixtures/v1/overlay.response.json | 5 ++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/contracts/v1/overlay-response.json b/contracts/v1/overlay-response.json index f7b3f52..5480fd4 100644 --- a/contracts/v1/overlay-response.json +++ b/contracts/v1/overlay-response.json @@ -4,13 +4,16 @@ "title": "Trixie public overlay", "type": "object", "additionalProperties": false, - "required": ["slug", "html", "css", "javascript", "enabled", "disabled_design"], + "required": ["slug", "html", "css", "javascript", "enabled", "disabled_design", "alert_group_window_ms", "alert_group_size", "alert_display_ms"], "properties": { "slug": { "type": "string", "pattern": "^[a-z0-9-]+$" }, "html": { "type": "string" }, "css": { "type": "string" }, "javascript": { "type": "string" }, "enabled": { "type": "boolean" }, - "disabled_design": { "type": "string" } + "disabled_design": { "type": "string" }, + "alert_group_window_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, + "alert_group_size": { "type": "integer", "minimum": 1, "maximum": 20 }, + "alert_display_ms": { "type": "integer", "minimum": 500, "maximum": 60000 } } } diff --git a/fixtures/v1/overlay.response.json b/fixtures/v1/overlay.response.json index 08956af..52d5f29 100644 --- a/fixtures/v1/overlay.response.json +++ b/fixtures/v1/overlay.response.json @@ -4,5 +4,8 @@ "css": "#alert { color: white; }", "javascript": "", "enabled": true, - "disabled_design": "transparent" + "disabled_design": "transparent", + "alert_group_window_ms": 200, + "alert_group_size": 5, + "alert_display_ms": 4000 }