From b5ecd3910023f76a3cfdc4df330d33ba11d8e569 Mon Sep 17 00:00:00 2001 From: hsiegeln <37154749+hsiegeln@users.noreply.github.com> Date: Thu, 23 Apr 2026 00:39:10 +0200 Subject: [PATCH] docs(api): document ?apply query param on updateConfig (Swagger) Adds @Parameter description so the generated OpenAPI spec / Swagger UI explains what 'staged' vs 'live' means instead of just surfacing the bare param name. Follow-up: run `cd ui && npm run generate-api:live` against a live backend to refresh openapi.json + schema.d.ts. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../server/app/controller/ApplicationConfigController.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cameleer-server-app/src/main/java/com/cameleer/server/app/controller/ApplicationConfigController.java b/cameleer-server-app/src/main/java/com/cameleer/server/app/controller/ApplicationConfigController.java index 9a333fe7..05941123 100644 --- a/cameleer-server-app/src/main/java/com/cameleer/server/app/controller/ApplicationConfigController.java +++ b/cameleer-server-app/src/main/java/com/cameleer/server/app/controller/ApplicationConfigController.java @@ -24,6 +24,7 @@ import com.cameleer.server.core.storage.DiagramStore; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.servlet.http.HttpServletRequest; @@ -114,6 +115,8 @@ public class ApplicationConfigController { @ApiResponse(responseCode = "400", description = "Unknown apply value (must be 'staged' or 'live')") public ResponseEntity updateConfig(@EnvPath Environment env, @PathVariable String appSlug, + @Parameter(name = "apply", + description = "When to apply: 'live' (default) saves and pushes CONFIG_UPDATE to live agents immediately; 'staged' saves without pushing — the next successful deploy applies it.") @RequestParam(name = "apply", defaultValue = "live") String apply, @RequestBody ApplicationConfig config, Authentication auth,