chore: Action schema description updates

fortify · May 15, 2024 · 951d1cf · 951d1cf
1 parent 2ebb3d8
commit 951d1cf
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionParameter.java b/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionParameter.java
@@ -29,13 +29,13 @@
 @Reflectable @NoArgsConstructor
 @Data
 public final class ActionParameter implements IActionElement {
-    @JsonPropertyDescription("Required string: Action parameter name. This will allow the action to accept CLI options named `--<name>` or `-<name>` for single-letter names. Parameter value can be referenced through ${parameters.name} in SpEL template expressions.")
+    @JsonPropertyDescription("Required string: Action parameter name. This will allow the action to accept CLI options named `--[name]` or `-[name]` for single-letter names. Parameter value can be referenced through ${parameters.name} in SpEL template expressions.")
     @JsonProperty(required = true) private String name;
 
     @JsonPropertyDescription("Required string: Action parameter description to be shown in action usage help.")
     @JsonProperty(required = true) private String description;
 
-    @JsonPropertyDescription("Optional string: Comma-separated CLI option aliases. This will allow the action to accept CLI options named `--<alias>` or `-<alias>` for single-letter aliases. Aliases cannot be referenced in SpEL expressions.")
+    @JsonPropertyDescription("Optional string: Comma-separated CLI option aliases. This will allow the action to accept CLI options named `--[alias]` or `-[alias]` for single-letter aliases. Aliases cannot be referenced in SpEL expressions.")
     @JsonProperty(required = false) private String cliAliases;
 
     @JsonPropertyDescription("Optional string: Action parameter type. Supported types depends on the fcli module (SSC/FoD) from which the action is being run. See built-in actions for examples of supported types.")