Skip to content

Commit 7d522de

Browse files
authored
Merge pull request #22723 from github/repo-sync
repo sync
2 parents 2ba477c + 8497e3f commit 7d522de

File tree

12 files changed

+22
-38
lines changed

12 files changed

+22
-38
lines changed

content/index.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,6 @@ childGroups:
134134
- education
135135
- support
136136
externalProducts:
137-
atom:
138-
id: atom
139-
name: Atom
140-
href: 'https://atom.io/docs'
141-
external: true
142137
electron:
143138
id: electron
144139
name: Electron

content/rest/dependabot/alerts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '{% data variables.product.prodname_dependabot_alerts %}'
33
allowTitleToDifferFromFilename: true
44
shortTitle: Alerts
5-
intro: 'With the {% data variables.product.prodname_dependabot_alerts %} API, you can view and manage {% data variables.product.prodname_dependabot %} alerts for a repository.'
5+
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts for a repository.'
66
versions:
77
feature: dependabot-alerts-rest-api
88
topics:
@@ -12,10 +12,10 @@ miniTocMaxHeadingLevel: 3
1212

1313
{% note %}
1414

15-
**Note**: The Dependabot alerts API is currently in public beta and subject to change.
15+
**Note**: The ability to use the REST API to manage Dependabot alerts is currently in public beta and subject to change.
1616

1717
{% endnote %}
1818

19-
## About the {% data variables.product.prodname_dependabot_alerts %} API
19+
## About {% data variables.product.prodname_dependabot_alerts %}
2020

21-
The {% data variables.product.prodname_dependabot_alerts %} API lets you view {% data variables.product.prodname_dependabot %} alerts for a repository and update individual alerts. For more information, see "[About Dependabot alerts](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."
21+
You can view {% data variables.product.prodname_dependabot %} alerts for a repository and update individual alerts with the REST API. For more information, see "[About Dependabot alerts](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."

content/rest/dependabot/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Dependabot
3-
intro: 'With the {% data variables.product.prodname_dependabot %} API, you can manage {% data variables.product.prodname_dependabot %} alerts and secrets for an organization or repository.'
3+
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts and secrets for an organization or repository.'
44
allowTitleToDifferFromFilename: true
55
versions:
66
fpt: '*'

content/rest/dependabot/secrets.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Dependabot secrets
33
shortTitle: Secrets
4-
intro: 'With the {% data variables.product.prodname_dependabot %} secrets API, you can manage and control {% data variables.product.prodname_dependabot %} secrets for an organization or repository.'
4+
intro: 'Use the REST API to manage {% data variables.product.prodname_dependabot %} secrets for an organization or repository.'
55
topics:
66
- API
77
versions:
@@ -11,8 +11,8 @@ versions:
1111
allowTitleToDifferFromFilename: true
1212
---
1313

14-
## About the {% data variables.product.prodname_dependabot %} secrets API
14+
## About {% data variables.product.prodname_dependabot %} secrets
1515

16-
The {% data variables.product.prodname_dependabot %} secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)."
16+
You can create, update, delete, and retrieve information about encrypted secrets using the REST API. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)."
1717

18-
{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets.
18+
{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Dependency review
3-
intro: 'The Dependency review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.'
3+
intro: 'Use the REST API to interact with dependency changes.'
44
versions:
55
fpt: '*'
66
ghes: '>=3.6'
@@ -12,6 +12,6 @@ miniTocMaxHeadingLevel: 3
1212
allowTitleToDifferFromFilename: true
1313
---
1414

15-
## About the Dependency review API
15+
## About dependency review
1616

17-
The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)."
17+
You can use the REST API to view dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)."
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: Dependency submission
3-
intro: 'The Dependency submission API allows you to submit dependencies for projects, such as the dependencies resolved when a project is built or compiled.'
3+
intro: 'Use the REST API to submit dependencies.'
44
versions:
55
feature: dependency-submission-api
66
miniTocMaxHeadingLevel: 3
77
---
88

9-
## About the Dependency submission API
9+
## About dependency submissions
1010

1111
{% data reusables.dependency-submission.dependency-submission-api-beta %}
1212

1313
{% data reusables.dependency-submission.about-dependency-submission %}
1414

15-
Dependencies are submitted to the dependency submission API 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. You can choose to use pre-made actions or create your own actions to submit your dependencies to the dependency submission API in the required format each time your project is built. For more information about using the Dependency submission API, see "[Using the Dependency submission API](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)."
15+
You can submit dependencies 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. You can choose to use pre-made actions or create your own actions to submit your dependencies in the required format each time your project is built. For more information, see "[Using the Dependency submission API](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)."
1616

17-
You can submit multiple sets of dependencies to the Dependency submission API to be included in your dependency graph. The API uses the `job.correlator` property and the `detector.name` category of the snapshot to ensure the latest submissions for each workflow get shown. The `correlator` property itself is the primary field you will use to keep independent submissions distinct. An example `correlator` could be a simple combination of two variables available in actions runs: `<GITHUB_WORKFLOW> <GITHUB_JOB>`.
17+
You can submit multiple sets of dependencies to be included in your dependency graph. The REST API uses the `job.correlator` property and the `detector.name` category of the snapshot to ensure the latest submissions for each workflow get shown. The `correlator` property itself is the primary field you will use to keep independent submissions distinct. An example `correlator` could be a simple combination of two variables available in actions runs: `<GITHUB_WORKFLOW> <GITHUB_JOB>`.

content/rest/dependency-graph/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Dependency Graph
3-
intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.'
3+
intro: 'Use the REST API to view dependency changes and their security impact on your repository.'
44
versions:
55
fpt: '*'
66
ghes: '>=3.6'

content/rest/deploy-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy keys
3-
intro: The Deploy keys API lets you create and manage deploy keys.
3+
intro: Use the REST API to create and manage deploy keys.
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -14,7 +14,7 @@ redirect_from:
1414
- /rest/reference/deploy_keys
1515
---
1616

17-
## About the Deploy keys API
17+
## About deploy keys
1818

1919
{% data reusables.repositories.deploy-keys %}
2020

data/reusables/dependency-submission/about-dependency-submission.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The Dependency submission API lets you submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to {% data variables.product.prodname_dotcom %}'s dependency graph feature, providing a more complete picture of all of your project's dependencies.
1+
You can use the REST API to submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to {% data variables.product.prodname_dotcom %}'s dependency graph feature, providing a more complete picture of all of your project's dependencies.
22

33
The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see "[Exploring the dependencies of a repository](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph)."
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% note %}
22

3-
**Note:** The Dependency submission API is currently in public beta and subject to change.
3+
**Note:** The ability to use the REST API for dependency submission is currently in public beta and subject to change.
44

55
{% endnote %}

0 commit comments

Comments
 (0)