From eb1e20838a52d0d2b479c36f5ddd5d8ad2473d53 Mon Sep 17 00:00:00 2001 From: MikiP98 Date: Tue, 10 Sep 2024 22:40:01 +0200 Subject: [PATCH] Added some comments to the API DOC --- content/src/UI/WebUI/API/DOC.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/src/UI/WebUI/API/DOC.md b/content/src/UI/WebUI/API/DOC.md index a1b9431..60f770f 100644 --- a/content/src/UI/WebUI/API/DOC.md +++ b/content/src/UI/WebUI/API/DOC.md @@ -10,14 +10,13 @@ from typing import TypedDict class AlgorithmConfigDTO(TypedDict): - id: int - display_name: str | None - description: str | None + name: str # Not using ID so that new algorithms won't break API compat + display_name: str | None # If left empty, WebUI will try to use the hardcoded clientside display_name + description: str | None # If left empty, WebUI will try to use the hardcoded clientside description non_cost_per_output_pixel: int premium_cost_per_output_pixel: int premium_only: bool - class ServerConfigDTO(TypedDict): api_version: str algorithm_configs: list[AlgorithmConfigDTO]