Skip to content

Commit 554a03e

Browse files
author
skedwards88
committed
add API page
1 parent 61e8281 commit 554a03e

6 files changed

Lines changed: 27 additions & 10 deletions

File tree

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,13 @@ versions:
66
feature: dependency-submission-api
77
---
88

9-
{% note %}
10-
11-
**Note:** The Dependency submission API is currently in beta and subject to change
12-
13-
{% endnote %}
9+
{% data reusables.dependency-submission.dependency-submission-api-beta %}
1410

1511
## About the Dependency submission API
1612

17-
The Dependency submission API lets you submit dependencies for a project to generate a dependency graph. This enables you to generate a dependency graph for projects that resolve dependencies when the software is built or compiled. Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities.
18-
19-
Projects that declare their dependencies in a file that is committed to the repository (for example, a `package-lock.json` file in a JavaScript project) do not need to use the Dependency submission API in order to generate a dependency graph. However, these projects can still use the Dependency submission API.
13+
{% data reusables.dependency-submission.about-dependency-submission %}
2014

21-
For more information about the Dependency submission API, see the [Dependency graph REST API documentation](/rest/dependency-graph).
15+
For more information about the Dependency submission API, see the [Dependency submission REST API documentation](/rest/dependency-graph/dependency-submission).
2216

2317
## Submitting dependencies at build-time
2418

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Dependency submission
3+
intro: 'The Dependency submission API allows you to submit dependencies for projects that resolve dependencies when the project is built or compiled.'
4+
versions:
5+
feature: dependency-submission-api
6+
miniTocMaxHeadingLevel: 3
7+
---
8+
9+
## About the Dependency review API
10+
11+
{% data reusables.dependency-submission.dependency-submission-api-beta %}
12+
13+
{% data reusables.dependency-submission.about-dependency-submission %}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ topics:
1111
miniTocMaxHeadingLevel: 3
1212
children:
1313
- /dependency-review
14+
- /dependency-submission
1415
redirect_from:
1516
- /rest/reference/dependency-graph
1617
---

‎data/features/dependency-submission-api.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
versions:
33
fpt: '*'
44
ghec: '*'
5-
# ghes: '>=3.6' GHES version still TBD
5+
ghes: '>=3.6'
66
ghae: 'issue-6397'

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
The Dependency submission API lets you submit dependencies for a project to generate a dependency graph. This enables you to generate a dependency graph for projects
2+
that resolve dependencies when the software is built or compiled. Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities.
3+
4+
Projects that declare their dependencies in a file that is committed to the repository (for example, a `package-lock.json` file in a JavaScript project) do not need to use the Dependency submission API in order to generate a dependency graph. However, these projects can still use the Dependency submission API.

‎data/reusables/dependency-submission/dependency-submission-api-beta.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% note %}
2+
3+
**Note:** The Dependency submission API is currently in beta and subject to change
4+
5+
{% endnote %}

0 commit comments

Comments
 (0)