docs: Improve Swagger docs (#169)

* Basically to say that the id should not be passed when creating new StrategyConfigs and MarketConfigs using the REST API - the system bot will generate them.
gazbert · Nov 14, 2024 · 3733bcb · 3733bcb
1 parent fb9eaa1
commit 3733bcb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/bxbot-domain-objects/src/main/java/com/gazbert/bxbot/domain/market/MarketConfig.java b/bxbot-domain-objects/src/main/java/com/gazbert/bxbot/domain/market/MarketConfig.java
@@ -37,10 +37,11 @@
 public class MarketConfig {
 
   @Schema(
-      requiredMode = Schema.RequiredMode.REQUIRED,
+      requiredMode = Schema.RequiredMode.NOT_REQUIRED,
       description =
-          "A unique identifier for the Market. Value must be an alphanumeric string. "
-              + "Underscores and dashes are also permitted.")
+          "A unique identifier for the Market. Value is an alphanumeric string. "
+              + "Underscores and dashes are also permitted. Do not set this field when creating "
+              + "a new MarketConfig using REST API - it will be generated by the bot.")
   private String id;
 
   @Schema(description = "An optional friendly name for the Market.")

diff --git a/bxbot-domain-objects/src/main/java/com/gazbert/bxbot/domain/strategy/StrategyConfig.java b/bxbot-domain-objects/src/main/java/com/gazbert/bxbot/domain/strategy/StrategyConfig.java
@@ -39,10 +39,11 @@
 public class StrategyConfig {
 
   @Schema(
-      requiredMode = Schema.RequiredMode.REQUIRED,
+      requiredMode = Schema.RequiredMode.NOT_REQUIRED,
       description =
-          "A unique identifier for the Strategy. Value must be an alphanumeric string. "
-              + "Underscores and dashes are also permitted.")
+          "A unique identifier for the Strategy. Value is an alphanumeric string. "
+              + "Underscores and dashes are also permitted. Do not set this field when creating "
+              + "a new StrategyConfig using REST API - it will be generated by the bot.")
   private String id;
 
   @Schema(description = "An optional friendly name for the Strategy.")