Skip to content

Commit 702ddc8

Browse files
authored
update docs for finding details v2 GA (#2200)
1 parent f7f60b8 commit 702ddc8

21 files changed

+45
-71
lines changed

docs/contributing/contributing-rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ technology:
519519

520520
#### Vulnerability class
521521

522-
The vulnerability class defines the category to which a rule and its resulting findings belong. The categories are used to group rules in Semgrep AppSec Platform's **Policies** page to help find similar rules. The category is also displayed on the **Findings Details** pages.
522+
The vulnerability class defines the category to which a rule and its resulting findings belong. The categories are used to group rules in Semgrep AppSec Platform's **Policies** page to help find similar rules. The category is also displayed on the **Finding Details** pages.
523523

524524
You can provide custom values. Sample values include:
525525

docs/secure-guardrails/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Semgrep provides customizability through:
123123
- Custom rules - You can create custom rules and deploy them as guardrails. Learn more about Semgrep rule structure in [the next section](#remediation-guidance).
124124
- Assistant Memories - this feature allows you to add and save additional context when Semgrep Assistant provides remediation. For example, you can provide organization-specific public keys, which Semgrep Assistant remembers.
125125

126-
![Assistant Memories form within a finding's details page](/img/guardrails-memories.png#md-width-centered)
126+
![Assistant Memories form within a finding's details page](/img/memories-2.png#md-width-centered)
127127
_**Figure**. A form on a finding's details page where you can enter additional instructions or context._
128128

129129
### Remediation guidance

docs/semgrep-appsec-platform/findings-details.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
displayed_sidebar: scanSidebar
33
slug: details-page
4-
title: Details page v2
4+
id: details-page
5+
title: Finding details page v2
56
hide_title: true
67
description: Each finding in Semgrep has its own details page which provides you with the information and tools to analyze and triage the finding.
78
tags:
@@ -11,7 +12,7 @@ tags:
1112
# Details page for findings v2
1213

1314
:::info
14-
This document describes the **findings details page v2**, a feature which is in **private beta**. This feature supercedes the current findings details page, hereafter referred to as v1.
15+
This document describes the **findings details page v2**, a feature generally available as of 20 June 2025. This feature supercedes the earlier finding details page, hereafter referred to as v1.
1516

1617
Refer to this document to understand changes between the two versions.
1718
:::

docs/semgrep-appsec-platform/jira.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The Jira integration automatically detects other Jira projects in your subdomain
8080
- Those projects have the same **Issue type** as the default project. [When you triage a finding](#code), you can choose which project to create the tickets in.
8181

8282
:::caution Same name, different ID
83-
Issue types may have the same name, but a different Issue type ID. When creating tickets, only company-managed Jira projects with the same issue type ID as the default project selected in the integration will appear. If you can't select other Jira projects when creating tickets, check that the Issue type ID is the same across Jira projects. See the [<i class="fas fa-external-link fa-xs"></i> Jira documentation](https://confluence.atlassian.com/jirasoftwarecloud/finding-the-issue-type-id-in-jira-cloud-1333825937.html) for details.
83+
Issue types may have the same name, but a different Issue type ID. When creating tickets, only company-managed Jira projects with the same issue type ID as the default project selected in the integration will appear. If you can't select other Jira projects when creating tickets, check that the Issue type ID is the same across Jira projects. See the [<i class="fas fa-external-link fa-xs"></i> How to identify the Jira Issue ID in Cloud](https://support.atlassian.com/jira/kb/how-to-identify-the-jira-issue-id-in-cloud/) for details.
8484
:::
8585

8686
### Create mappings
@@ -220,7 +220,10 @@ _**Figure.** Code triage flow._
220220
Once a ticket has been created, a link appears on the **Findings** page and along the top of an individual finding's details page.
221221

222222
![Jira ticket created - Code](/img/jira-code-ticketed.png#md-width)
223-
_**Figure.** Code ticket created._
223+
_**Figure.** Ticket created and its ID shown on the finding listed on the Code page._
224+
225+
![Jira ticket created - Finding Details](/img/jira-ticket-finding-details.png#md-width)
226+
_**Figure.** Ticket created and its ID shown on the finding details page._
224227

225228
### Supply Chain
226229

@@ -279,11 +282,11 @@ Semgrep provides an API endpoint you can use to create Jira tickets, either by p
279282

280283
1. Sign in to [Semgrep AppSec Platform](https://semgrep.dev/login).
281284
2. In the navigation bar, click the product whose findings you want to see.
282-
3. Identify the finding associated with the Jira ticket, and open its findings details page.
285+
3. Identify the finding associated with the Jira ticket, and open its finding details page.
283286
4. Click **Fix**, and in the drop-down box that appears, click **Unlink <PL>TICKET ID</PL>**.
284287

285-
![The findings details page with the option to unlink a Jira ticket displayed.](/img/unlink-jira.png#md-width)
286-
_**Figure**. The findings details page with the option to unlink a Jira ticket displayed._
288+
![The finding details page with the option to unlink a Jira ticket displayed.](/img/unlink-jira.png#md-width)
289+
_**Figure**. The finding details page with the option to unlink a Jira ticket displayed._
287290

288291
## Remove the Jira integration
289292

docs/semgrep-assistant/customize.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,13 @@ Memories are enabled by default for all organizations with Assistant enabled.
6363
To add a memory based on a suggested fix presented by Assistant:
6464

6565
1. Identify the specific instance of **Assistant's suggested fix** that you want to modify. These can be found on the finding details page or in the PR or MR comment.
66-
2. Click **Customize fix** to open an input box, and enter your preferred remediation approaches and secure defaults for the project. Your suggestion can be as general as "Use AWS Secrets Manager to manage secrets."
67-
![Assistant’s suggested fix for a hardcoded secret in the user’s code](/img/memories-3.png#md-width)
66+
![Assistant’s suggested fix for a hardcoded secret in the user’s code](/img/memories-1.png#md-width)
6867
***Figure***. Assistant’s suggested fix for a hardcoded secret in the user’s code.
69-
3. Click **Save and regenerate**.
68+
2. Click **Customize fix** to open an input box, and enter your preferred remediation approaches and secure defaults for the project. Your suggestion can be as general as "Use AWS Secrets Manager to manage secrets."
7069
![User-provided custom instruction that Assistant uses to improve future guidance.](/img/memories-2.png#md-width)
7170
***Figure***. User-provided custom instruction that Assistant uses to improve future guidance.
71+
3. Click **Save and regenerate**.
7272
4. Assistant regenerates the suggested fix to reflect the instructions you provided.
73-
![Regenerated Assistant fix using the user-provided instructions.](/img/memories-1.png#md-width)
74-
***Figure***. Regenerated Assistant fix using the user-provided instructions.
7573

7674
Memories are scoped to remediation guidance on a per-project and per-rule basis. A saved memory only affects future guidance for findings triggered by the same rule in the same project.
7775

docs/semgrep-assistant/overview.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ _**Figure.** PR comment displaying the rule message followed by a comment that c
4444

4545
Semgrep also displays remediation information on Semgrep AppSec Platform's **Findings page** under **Your code & fix** in the [finding's details](/docs/semgrep-code/findings/#view-findings-details-about-a-specific-finding) page.
4646

47-
![Findings detail with remediation advice](/img/assistant-guidance-ui.png#md-width)
47+
![Findings detail with remediation advice](/img/memories-1.png#md-width)
4848
_**Figure.** Findings detail page with the Your code & fix section displaying the suggested fix._
4949

5050
#### Autofix
@@ -58,13 +58,11 @@ Autofixes are available in PR and MR comments, so developers can review and veri
5858
![Semgrep Assistant generating a potential fix in a comment](/img/semgrep-assistant-autofix.png#md-width)
5959
_**Figure.** Semgrep Assistant generates a potential fix in a PR comment._
6060

61-
Autofixes are also available on Semgrep AppSec Platform's **Findings page** under **Your code & fix** in the [finding's details](/docs/semgrep-code/findings/#view-findings-details-about-a-specific-finding).
61+
Autofixes are also available on Semgrep AppSec Platform's **Findings page** under **Assistant suggested fix** in the [finding's details](/docs/semgrep-code/findings/#view-findings-details-about-a-specific-finding).
6262

6363
![Semgrep Assistant showing a potential fix in Semgrep AppSec Platform](/img/assistant-autofix-ui.png#md-width)
6464
*Figure*. Semgrep Assistant showing a potential fix in Semgrep AppSec Platform.
6565

66-
The finding's details include a link to the PR or MR with the autofix, so you can go directly to the PR or MR to commit the autofix.
67-
6866
:::info
6967
If many new issues are found in a given scan, Assistant auto-triage and autofix may not run on every issue.
7068
:::

docs/semgrep-code/findings.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -123,32 +123,26 @@ You can identify findings categorized under **Security** by their badge.
123123
![Screenshot of security badge](/img/findings-security-badge.png#md-width)
124124
:::
125125

126-
### View findings details about a specific finding
126+
### View details about a specific finding
127127

128128
To view in-depth information about a specific finding:
129129

130-
1. Select the finding whose details you want to view details:
130+
1. Select the finding whose details you want to view:
131131
- If the default **Group by Rule** is enabled, click the <i class="fa-regular fa-window-restore"></i> **Details** icon on the card of the finding.
132132
![Click View details if Group by Rule is enabled](/img/cloud-platform-findings-group-by-rule-view-details.png#md-width)
133-
- If the **No grouping** view is enabled, click the **header hyperlink** on the card of the finding. In the example on the screenshot below, it is the **detected-generic-api-key**.
133+
- If the **No grouping** view is enabled, click the **header hyperlink** on the card of the finding. In the example screenshot below, the link is labeled **detected-generic-api-key**.
134134
![Click View details if No grouping is enabled](/img/cloud-platform-findings-no-grouping-view-details.png#md-width)
135+
135136
#### Add notes to findings
136137

137138
To **add notes** to the activity history of a finding:
138139

139140
1. Select a finding where you want to view details or add notes, and then do one of the following actions:
140141
- If the default **Group by Rule** is enabled, click <i class="fa-regular fa-window-restore"></i> **Details** icon on the card of the finding.
141142
![Click View details if Group by Rule is enabled](/img/cloud-platform-findings-group-by-rule-view-details.png#md-width)
142-
- If **No grouping** view is enabled, click the **header hyperlink** on the card of the finding. In the example on the screenshot below, it is the **detected-generic-api-key**.
143+
- If **No grouping** view is enabled, click the **header hyperlink** on the card of the finding. In the example screenshot below, the link is labeled **detected-generic-api-key**.
143144
![Click View details if No grouping is enabled](/img/cloud-platform-findings-no-grouping-view-details.png#md-width)
144-
2. View, or add the notes in the **Activity** section. To add a new note, click plus **New note**.
145-
![Semgrep AppSec Platform finding details page](/img/cloud-platform-finding-details.png#md-width)
146-
### View branches that contain the finding
147-
148-
To view all the branches that contain the finding, click the finding's **details page**. You can see all the branches on the **On <span className="placeholder">N</span> branches** pane.
149-
150-
![Details page > On N branches](/img/details-on-n-branches.png#sm-width)
151-
_**Figure**. **Details page > On <span className="placeholder">N</span> branches** pane._
145+
2. View or add the notes in the **Activity** section. To add a new note, click **New note**.
152146

153147
## Dataflow traces
154148

sidebars.js

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,15 @@ module.exports = {
8888
items: [
8989
'deployment/deployment-checklist',
9090
'deployment/create-account-and-orgs',
91-
'deployment/connect-scm',
91+
{
92+
type: 'category',
93+
collapsible: true,
94+
label: 'Connect a source code manager',
95+
link: {type: 'doc', id: 'deployment/connect-scm'},
96+
items: [
97+
'semgrep-appsec-platform/scm-code-access'
98+
]
99+
},
92100
/* 'semgrep-cloud-platform/scm', superseded by connect-scm */
93101
'deployment/sso',
94102
{
@@ -259,6 +267,15 @@ module.exports = {
259267
items: [
260268
'semgrep-code/overview',
261269
'semgrep-code/findings',
270+
{
271+
type: 'category',
272+
collapsible: true,
273+
label: 'View findings',
274+
link: {type: 'doc', id: 'semgrep-code/findings',},
275+
items: [
276+
'semgrep-appsec-platform/details-page',
277+
]
278+
},
262279
'semgrep-code/policies',
263280
'semgrep-code/triage-remediation',
264281
'semgrep-code/semgrep-pro-engine-intro',
@@ -403,8 +420,7 @@ module.exports = {
403420
]
404421
},
405422
'cli-reference',
406-
'semgrep-appsec-platform/json-and-sarif',
407-
'semgrep-appsec-platform/scm-code-access'
423+
'semgrep-appsec-platform/json-and-sarif'
408424
]
409425
}
410426
],

src/components/procedure/_integrate-slack.mdx

Lines changed: 0 additions & 36 deletions
This file was deleted.

src/components/procedure/_semgrep-code-display-tainted-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To view the detailed path of tainted data with dataflow traces:
88
1. Select the finding you're interested in, then do one of the following actions:
99
- If the default **Group by Rule** is enabled, click <i class="fa-regular fa-window-restore"></i> **View details** icon on the card of the finding.
1010
![Click View details if Group by Rule is enabled](/img/cloud-platform-findings-group-by-rule-view-details.png#md-width)
11-
- If **No grouping** view is enabled, click the **header hyperlink** on the card of the finding. In the example on the screenshot below, it is the **tainted-sql-string**.
11+
- If **No grouping** view is enabled, click the **header hyperlink** on the card of the finding. In the example screenshot below, the link is titled **tainted-sql-string**.
1212
![Click View details if No grouping is enabled](/img/cloud-platform-findings-no-grouping-view-details.png#md-width)
1313
1. In the <i class="fa-solid fa-droplet"></i> **Data flow** <i class="fa-regular fa-circle-info"></i> section, you can see the source, traces, and sink of the tainted data. The example below displays the path of tainted data across multiple files because Semgrep Pro Engine was enabled. Clicking on a specific line in the trace will highlight it in the context of the file, while clicking on the file name at the top of the right pane will take you directly to that file in your source code manager (GitHub, GitLab, etc.). If you don't have code access enabled, you'll still see the link to your source code manager.
1414
![Data flow in Finding details page](/img/cloud-platform-findings-details-data-flow.png#md-width)

0 commit comments

Comments
 (0)