Skip to content

Commit

Permalink
Unify language in API docs for Deploy keys, Dependabot, Dependency re…
Browse files Browse the repository at this point in the history
…view APIs (github#33365)

Co-authored-by: Jess Hosman <[email protected]>
  • Loading branch information
saritai and jhosman authored Dec 15, 2022
1 parent accfd41 commit 1792eca
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions content/rest/dependabot/alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: '{% data variables.product.prodname_dependabot_alerts %}'
allowTitleToDifferFromFilename: true
shortTitle: Alerts
intro: 'With the {% data variables.product.prodname_dependabot_alerts %} API, you can view and manage {% data variables.product.prodname_dependabot %} alerts for a repository.'
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts for a repository.'
versions:
feature: dependabot-alerts-rest-api
topics:
Expand All @@ -12,10 +12,10 @@ miniTocMaxHeadingLevel: 3

{% note %}

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

{% endnote %}

## About the {% data variables.product.prodname_dependabot_alerts %} API
## About {% data variables.product.prodname_dependabot_alerts %}

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)."
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)."
2 changes: 1 addition & 1 deletion content/rest/dependabot/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dependabot
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.'
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts and secrets for an organization or repository.'
allowTitleToDifferFromFilename: true
versions:
fpt: '*'
Expand Down
8 changes: 4 additions & 4 deletions content/rest/dependabot/secrets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Dependabot secrets
shortTitle: Secrets
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.'
intro: 'Use the REST API to manage {% data variables.product.prodname_dependabot %} secrets for an organization or repository.'
topics:
- API
versions:
Expand All @@ -11,8 +11,8 @@ versions:
allowTitleToDifferFromFilename: true
---

## About the {% data variables.product.prodname_dependabot %} secrets API
## About {% data variables.product.prodname_dependabot %} secrets

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)."
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)."

{% 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.
{% 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.
6 changes: 3 additions & 3 deletions content/rest/dependency-graph/dependency-review.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dependency review
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.'
intro: 'Use the REST API to interact with dependency changes.'
versions:
fpt: '*'
ghes: '>=3.6'
Expand All @@ -12,6 +12,6 @@ miniTocMaxHeadingLevel: 3
allowTitleToDifferFromFilename: true
---

## About the Dependency review API
## About dependency review

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)."
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)."
8 changes: 4 additions & 4 deletions content/rest/dependency-graph/dependency-submission.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Dependency submission
intro: 'The Dependency submission API allows you to submit dependencies for projects, such as the dependencies resolved when a project is built or compiled.'
intro: 'Use the REST API to submit dependencies.'
versions:
feature: dependency-submission-api
miniTocMaxHeadingLevel: 3
---

## About the Dependency submission API
## About dependency submissions

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

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

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)."
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)."

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>`.
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>`.
2 changes: 1 addition & 1 deletion content/rest/dependency-graph/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dependency Graph
intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.'
intro: 'Use the REST API to view dependency changes and their security impact on your repository.'
versions:
fpt: '*'
ghes: '>=3.6'
Expand Down
4 changes: 2 additions & 2 deletions content/rest/deploy-keys.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deploy keys
intro: The Deploy keys API lets you create and manage deploy keys.
intro: Use the REST API to create and manage deploy keys.
versions:
fpt: '*'
ghes: '*'
Expand All @@ -14,7 +14,7 @@ redirect_from:
- /rest/reference/deploy_keys
---

## About the Deploy keys API
## About deploy keys

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
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.
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.

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)."

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% note %}

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

{% endnote %}

0 comments on commit 1792eca

Please sign in to comment.