chore: Action schema description updates

fortify · May 15, 2024 · 2ebb3d8 · 2ebb3d8
1 parent 8055c65
commit 2ebb3d8
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 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,19 +29,19 @@
 @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.")
     @JsonProperty(required = false) private String type;
 
-    @JsonPropertyDescription("Optional map<string,SpEL template expression>: Action parameter type parameters to allow for additional configuration of the type converter configured through 'type'.")
+    @JsonPropertyDescription("Optional map(string,SpEL template expression): Action parameter type parameters to allow for additional configuration of the type converter configured through 'type'.")
     @JsonProperty(required = false) private Map<String, TemplateExpression> typeParameters;
 
     @JsonPropertyDescription("Optional SpEL template expression: Default value for this action parameter if no value is specified by the user.")

diff --git a/...re/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionRequestTarget.java b/...re/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionRequestTarget.java
@@ -34,7 +34,7 @@ public final class ActionRequestTarget implements IActionElement {
     @JsonPropertyDescription("Required SpEL template expression: Base URL to use for REST requests to this request target.")
     @JsonProperty(required = true) private TemplateExpression baseUrl;
 
-    @JsonPropertyDescription("Optional map<string,SpEL template expression>: Headers to be sent to this request target on every request.")
+    @JsonPropertyDescription("Optional map(string,SpEL template expression): Headers to be sent to this request target on every request.")
     @JsonProperty(required = false) private Map<String, TemplateExpression> headers;
 
     // TODO Add support for next page URL producer

diff --git a/...core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionStepRequest.java b/...core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionStepRequest.java
@@ -44,7 +44,7 @@ public final class ActionStepRequest extends AbstractActionStep {
     @JsonPropertyDescription("Required string if no default target has been configured through defaults.requestTarget: Target on which to execute the REST request. This may be 'fod' (for actions in FoD module), 'ssc' (for actions in SSC module), or a custom request target as configured through 'addRequestTargets'.")
     @JsonProperty(required = false) private String target;
 
-    @JsonPropertyDescription("Optional map<string,SpEL template expression>: Map of query parameters and corresponding values, for example 'someParam: ${name.property}'.")
+    @JsonPropertyDescription("Optional map(string,SpEL template expression): Map of query parameters and corresponding values, for example 'someParam: ${name.property}'.")
     @JsonProperty(required = false) private Map<String,TemplateExpression> query;
 
     @JsonPropertyDescription("Optional SpEL template expression: Request body to send with the REST request.")