Skip to content

Commit cc402f0

Browse files
skedwards88am-stead
skedwards88
and
am-stead
authored
update titles for REST API dependabot, dependency graph, code scanning, secret scanning, security alert docs (#49515)
Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
1 parent a194061 commit cc402f0

File tree

26 files changed

+45
-28
lines changed

26 files changed

+45
-28
lines changed

‎content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ This precision enhances the efficiency of code review and resolution processes,
7272
You can provide the source root for conversion from absolute to relative URIs in one of the following ways.
7373

7474
- [`checkout_path`](https://github.com/github/codeql-action/blob/c2c0a2908e95769d01b907f9930050ecb5cf050d/analyze/action.yml#L44-L47) input to the `github/codeql-action/analyze` action
75-
- `checkout_uri` parameter to the SARIF upload API endpoint. For more information, see "[AUTOTITLE](/rest/code-scanning#upload-an-analysis-as-sarif-data)" in the REST API documentation
75+
- `checkout_uri` parameter to the SARIF upload API endpoint. For more information, see "[AUTOTITLE](/rest/code-scanning#upload-an-analysis-as-sarif-data)."
7676
- [`invocation.workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) property in the SARIF file
7777

7878
If you provide a source root, any location of an artifact specified using an absolute URI must use the same URI scheme. If there is a mismatch between the URI scheme for the source root and one or more of the absolute URIs, the upload is rejected.

‎content/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Additionally, auto-dismissed alerts are still available for reporting and review
5656
- If you change the scope of a dependency from development to production.
5757
- If {% data variables.product.company_short %} modifies certain metadata for the related advisory.
5858

59-
Auto-dismissed alerts are defined by the `resolution:auto-dismiss` close reason. Automatic dismissal activity is included in alert webhooks, REST and GraphQL APIs, and the audit log. For more information, see "[AUTOTITLE](/rest/dependabot/alerts)" in the REST API documentation, and the "`repository_vulnerability_alert`" section in "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#repository_vulnerability_alert-category-actions)."
59+
Auto-dismissed alerts are defined by the `resolution:auto-dismiss` close reason. Automatic dismissal activity is included in alert webhooks, REST and GraphQL APIs, and the audit log. For more information, see "[AUTOTITLE](/rest/dependabot/alerts)," and the "`repository_vulnerability_alert`" section in "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#repository_vulnerability_alert-category-actions)."
6060

6161
## Further reading
6262

‎content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ You can access any advisory in the {% data variables.product.prodname_advisory_d
4141
The database is also accessible using the GraphQL API. {% ifversion GH-advisory-db-supports-malware %}By default, queries will return {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities unless you specify `type:malware`.{% endif %} For more information, see the "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#security_advisory)."
4242

4343
{% ifversion security-advisories-rest-api %}
44-
Additionally, you can access the {% data variables.product.prodname_advisory_database %} using the REST API. For more information, see "[AUTOTITLE](/rest/security-advisories/global-advisories)" in the REST API documentation.{% endif %}
44+
Additionally, you can access the {% data variables.product.prodname_advisory_database %} using the REST API. For more information, see "[AUTOTITLE](/rest/security-advisories/global-advisories)."{% endif %}
4545

4646
## Editing an advisory in the {% data variables.product.prodname_advisory_database %}
4747

‎content/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ With repository security advisories, you can:
4040
{% data reusables.repositories.security-advisories-republishing %}
4141

4242
{% ifversion repository-security-advisories-API %}
43-
You can also use the REST API to create, list, and update repository security advisories. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories)" in the REST API documentation.
43+
You can also use the REST API to create, list, and update repository security advisories. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories)."
4444
{% endif %}
4545

4646
You can give credit to individuals who contributed to a security advisory. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory#about-credits-for-security-advisories)."

‎content/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ shortTitle: Create repository advisories
2626
## Creating a security advisory
2727

2828
{% ifversion repository-security-advisories-API %}
29-
You can also use the REST API to create repository security advisories. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories)" in the REST API documentation.
29+
You can also use the REST API to create repository security advisories. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories)."
3030
{% endif %}
3131

3232
{% data reusables.repositories.navigate-to-repo %}

‎content/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ shortTitle: Edit repository advisories
2222
## Editing a security advisory
2323

2424
{% ifversion repository-security-advisories-API %}
25-
You can also use the REST API to edit repository security advisories. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories)" in the REST API documentation.
25+
You can also use the REST API to edit repository security advisories. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories)".
2626
{% endif %}
2727

2828
{% data reusables.repositories.navigate-to-repo %}

‎content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ If your company provides software to the US federal government per [Executive Or
3333

3434
## Exporting a software bill of material for your repository using the REST API
3535

36-
If you want to use the REST API to export an SBOM for your repository, see [AUTOTITLE](/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository) in the REST API documentation for more information.
36+
If you want to use the REST API to export an SBOM for your repository, see "[AUTOTITLE](/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository)."

‎content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ versions:
1717

1818
{% data reusables.dependency-submission.about-dependency-submission %}
1919

20-
Dependencies are submitted to the {% data variables.dependency-submission-api.name %} in the form of a snapshot. A snapshot is a set of dependencies associated with a commit SHA and other metadata, that reflects the current state of your repository for a commit. Snapshots can be generated from your dependencies detected at build time or from a software bill of materials (SBOM). There are {% data variables.product.prodname_actions %} that support either of these use cases. For more information about the {% data variables.dependency-submission-api.name %}, see the [dependency submission REST API documentation](/rest/dependency-graph/dependency-submission).
20+
Dependencies are submitted to the {% data variables.dependency-submission-api.name %} in the form of a snapshot. A snapshot is a set of dependencies associated with a commit SHA and other metadata, that reflects the current state of your repository for a commit. Snapshots can be generated from your dependencies detected at build time or from a software bill of materials (SBOM). There are {% data variables.product.prodname_actions %} that support either of these use cases. For more information about the {% data variables.dependency-submission-api.name %}, see "[AUTOTITLE](/rest/dependency-graph/dependency-submission)."
2121

2222
## Submitting dependencies at build-time
2323

@@ -90,7 +90,7 @@ jobs:
9090
Alternatively, you can write your own action to submit dependencies for your project at build-time. Your workflow should:
9191
9292
1. Generate a list of dependencies for your project.
93-
1. Translate the list of dependencies into the snapshot format accepted by the {% data variables.dependency-submission-api.name %}. For more information about the format, see the body parameters for the "Create a repository snapshot" API operation in the [Dependency submission REST API documentation](/rest/dependency-graph/dependency-submission).
93+
1. Translate the list of dependencies into the snapshot format accepted by the {% data variables.dependency-submission-api.name %}. For more information about the format, see the body parameters for the "Create a repository snapshot" API endpoint in "[AUTOTITLE](/rest/dependency-graph/dependency-submission)."
9494
1. Submit the formatted list of dependencies to the {% data variables.dependency-submission-api.name %}.
9595
9696
{% data variables.product.product_name %} maintains the [Dependency Submission Toolkit](https://github.com/github/dependency-submission-toolkit), a TypeScript library to help you build your own GitHub Action for submitting dependencies to the {% data variables.dependency-submission-api.name %}. For more information about writing an action, see "[AUTOTITLE](/actions/creating-actions)".

‎content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -202,13 +202,13 @@ There are additional post-migration steps for each feature.
202202

203203
When secret scanning is enabled for the destination repository, a scan of the entire repository will be performed. After the scan is complete, all alerts will be populated, but without remediation states.
204204

205-
You can use the REST API to update the alerts to mirror any remediations in the source repository. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/rest/secret-scanning)" in the REST API documentation.
205+
You can use the REST API to update the alerts to mirror any remediations in the source repository. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/rest/secret-scanning)."
206206

207207
The user associated with these updated remediations will be the user who owns the {% data variables.product.pat_generic %} that was used for the API calls, not the user who remediated the alert in the source repository, and the date associated with the remediation will be the date of the API call, not the date the alert was remediated in the source repository.
208208

209209
#### {% data variables.product.prodname_code_scanning_caps %}
210210

211-
{% data variables.product.prodname_code_scanning_caps %} alerts are not migrated by {% data variables.product.prodname_importer_proper_name %}. However, the alerts are available as SARIF data in the source repository. You can use the REST API to upload this data to the destination repository. For more information, see "[Code Scanning](/enterprise-cloud@latest/rest/code-scanning)" in the REST API documentation.
211+
{% data variables.product.prodname_code_scanning_caps %} alerts are not migrated by {% data variables.product.prodname_importer_proper_name %}. However, the alerts are available as SARIF data in the source repository. You can use the REST API to upload this data to the destination repository. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/rest/code-scanning)."
212212

213213
{% data variables.product.prodname_code_scanning_caps %} alerts that are populated this way will differ from the original alerts in the source repository.
214214

‎content/rest/code-scanning/code-scanning.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Code Scanning
2+
title: REST API endpoints for code scanning
3+
shortTitle: Code scanning
4+
allowTitleToDifferFromFilename: true
35
intro: >-
46
Use the REST API to retrieve and update {% data
57
variables.product.prodname_code_scanning %} alerts from a repository.

‎content/rest/code-scanning/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Code Scanning
2+
title: REST API endpoints for code scanning
3+
shortTitle: Code scanning
4+
allowTitleToDifferFromFilename: true
35
intro: >-
46
Use the REST API to retrieve and update {% data
57
variables.product.prodname_code_scanning %} alerts from a repository.

‎content/rest/dependabot/alerts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: '{% data variables.product.prodname_dependabot_alerts %}'
2+
title: 'REST API endpoints for {% data variables.product.prodname_dependabot_alerts %}'
33
allowTitleToDifferFromFilename: true
44
shortTitle: Alerts
55
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts for a repository.'

‎content/rest/dependabot/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Dependabot
2+
title: REST API endpoints for {% data variables.product.prodname_dependabot %}
3+
shortTitle: Dependabot
34
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts and secrets for an organization or repository.'
45
allowTitleToDifferFromFilename: true
56
versions:

‎content/rest/dependabot/secrets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Dependabot secrets
2+
title: REST API endpoints for Dependabot secrets
33
shortTitle: Secrets
44
intro: >-
55
Use the REST API to manage {% data variables.product.prodname_dependabot %}

‎content/rest/dependency-graph/dependency-review.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Dependency review
2+
title: REST API endpoints for dependency review
3+
shortTitle: Dependency review
34
intro: Use the REST API to interact with dependency changes.
45
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
56
fpt: '*'

‎content/rest/dependency-graph/dependency-submission.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Dependency submission
2+
title: REST API endpoints for dependency submission
3+
shortTitle: Dependency submission
4+
allowTitleToDifferFromFilename: true
35
intro: Use the REST API to submit dependencies.
46
versions:
57
fpt: '*'

‎content/rest/dependency-graph/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Dependency Graph
2+
title: REST API endpoints for the dependency graph
3+
shortTitle: Dependency graph
4+
allowTitleToDifferFromFilename: true
35
intro: Use the REST API to view dependency changes and their security impact on your repository.
46
versions:
57
fpt: '*'

‎content/rest/dependency-graph/sboms.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Software bill of materials (SBOM)
2+
title: REST API endpoints for software bill of materials (SBOM)
33
shortTitle: Software bill of materials (SBOM)
44
intro: >-
55
Use the REST API to export the software bill of materials (SBOM) for a

‎content/rest/secret-scanning/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Secret scanning
2+
title: REST API endpoints for secret scanning
3+
shortTitle: Secret scanning
4+
allowTitleToDifferFromFilename: true
35
intro: Use the REST API to retrieve and update secret alerts from a repository.
46
versions:
57
fpt: '*'

‎content/rest/secret-scanning/secret-scanning.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Secret scanning
2+
title: REST API endpoints for secret scanning
3+
shortTitle: Secret scanning
4+
allowTitleToDifferFromFilename: true
35
intro: Use the REST API to retrieve and update secret alerts from a repository.
46
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
57
fpt: '*'

‎content/rest/security-advisories/global-advisories.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Global security advisories
2+
title: REST API endpoints for global security advisories
3+
shortTitle: Global security advisories
34
intro: Use the REST API to view global security advisories.
45
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
56
fpt: '*'

‎content/rest/security-advisories/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Security advisories
2+
title: REST API endpoints for security advisories
3+
shortTitle: Security advisories
34
intro: Use the REST API to view and manage security advisories.
45
versions:
56
fpt: '*'

‎content/rest/security-advisories/repository-advisories.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Repository security advisories
2+
title: REST API endpoints for repository security advisories
3+
shortTitle: Repository security advisories
34
allowTitleToDifferFromFilename: true
45
intro: Use the REST API to view and manage repository security advisories.
56
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖

‎data/reusables/dependency-review/dependency-review-action-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
The {% data variables.dependency-review.action_name %} scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. The action is supported by an API endpoint that compares the dependencies between two revisions and reports any differences.
22

3-
For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[AUTOTITLE](/rest/dependency-graph/dependency-review)" in the API documentation.
3+
For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[AUTOTITLE](/rest/dependency-graph/dependency-review)."

‎data/reusables/security-advisory/private-repository-non-ghas-deprecation-note.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
This deprecation does not affect published security advisories on public repositories. {% ifversion ghec %}It also does not affect security advisories on private repositories that have GHAS enabled.{% endif %}
66

7-
Formerly published advisories in private repositories {% ifversion ghec %}that do not have GHAS enabled{% endif %} will disappear. If you need to save previously published advisories, you can download them using the {% data variables.product.prodname_dotcom %} REST API. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories?apiVersion=2022-11-28)" in the REST API documentation.
7+
Formerly published advisories in private repositories {% ifversion ghec %}that do not have GHAS enabled{% endif %} will disappear. If you need to save previously published advisories, you can download them using the {% data variables.product.prodname_dotcom %} REST API. For more information, see "[AUTOTITLE](/rest/security-advisories/repository-advisories?apiVersion=2022-11-28)."
88

99
{% endwarning %}

‎data/reusables/security-advisory/private-vulnerability-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Security researchers can also use the REST API to privately report security vulnerabilities. For more information, see "[Privately report a security vulnerability](/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability)" in the REST API documentation.
1+
Security researchers can also use the REST API to privately report security vulnerabilities. For more information, see "[Privately report a security vulnerability](/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability)."

0 commit comments

Comments
 (0)