Skip to content

Add remediation description for each issue in the --apply-remediations --preview output - #1086

Merged
rsenden merged 1 commit into
feat/v3.x/aviator/26.4from
dhanwanthp/fix/missing_remediation_text
Sep 1, 2026
Merged

Add remediation description for each issue in the --apply-remediations --preview output#1086
rsenden merged 1 commit into
feat/v3.x/aviator/26.4from
dhanwanthp/fix/missing_remediation_text

Conversation

@dhanwanthp

Copy link
Copy Markdown

The preview remediations feature currently does not provide remediation description along with the suggested remediation.

Below is a snippet of the current output structure:

{
      "issueId": "ISSUE-123",
      "status": "available",
      "files": {
        "Example.java": {
          "path": "src/main/java/com/example/Example.java",
          "encoding": "UTF-8",
          "changes": [...]
        }
      },
      "skipReason": null
 }

This fix will add the description field to the output, so the new structure will look like this:

{
      "issueId": "ISSUE-123",
      "status": "available",
      "description": "The code reads a value from a password field and logs it directly...",
      "files": {
        "Example.java": {
          "path": "src/main/java/com/example/Example.java",
          "encoding": "UTF-8",
          "changes": [...]
        }
      },
      "skipReason": null
}

Also, this fix will rename the appliedRemediations field in the output to availableRemediations but only in preview mode. The normal apply-remediations command (without the --preview flag) will have appliedRemediations in its output.

…and rename appliedRemediations key to availableRemediations only in --preview.
@dhanwanthp
dhanwanthp requested a review from rsenden September 1, 2026 13:09
@rsenden
rsenden merged commit 20a9c36 into feat/v3.x/aviator/26.4 Sep 1, 2026
30 of 31 checks passed
@rsenden
rsenden deleted the dhanwanthp/fix/missing_remediation_text branch September 1, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants