From 2ebb3d86fb0ce57f98e36c3502a51556450ff392 Mon Sep 17 00:00:00 2001 From: Ruud Senden <8635138+rsenden@users.noreply.github.com> Date: Wed, 15 May 2024 16:51:31 +0200 Subject: [PATCH] chore: Action schema description updates --- .../fortify/cli/common/action/model/ActionParameter.java | 6 +++--- .../cli/common/action/model/ActionRequestTarget.java | 2 +- .../fortify/cli/common/action/model/ActionStepRequest.java | 2 +- 3 files changed, 5 insertions(+), 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 index 97643598aa..1f9deb48e2 100644 --- 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 '--' or '-' 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 `--` or `-` 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 `--` or `-` 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: 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 typeParameters; @JsonPropertyDescription("Optional SpEL template expression: Default value for this action parameter if no value is specified by the user.") diff --git a/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionRequestTarget.java b/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionRequestTarget.java index e8ddc160c0..decd7bf03c 100644 --- a/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionRequestTarget.java +++ b/fcli-core/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: 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 headers; // TODO Add support for next page URL producer diff --git a/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionStepRequest.java b/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionStepRequest.java index 1da2125841..b878c09a55 100644 --- a/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/action/model/ActionStepRequest.java +++ b/fcli-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: 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 query; @JsonPropertyDescription("Optional SpEL template expression: Request body to send with the REST request.")