Added some comments to the API DOC

MikiP98 · Sep 10, 2024 · eb1e208 · eb1e208
1 parent 4438fa1
commit eb1e208
Showing 1 changed file with 3 additions and 4 deletions.
diff --git 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]