[API release]: Add link to SBOM API docs from product docs (#37288)

Co-authored-by: Sarah Edwards <skedwards88@github.com>
This commit is contained in:
mc 2023-06-05 15:53:34 +01:00 коммит произвёл GitHub
Родитель a6bc37ed12
Коммит 4eced69d10
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 12 добавлений и 2 удалений

Просмотреть файл

@ -16,7 +16,9 @@ shortTitle: Export dependencies as SBOM
{% data reusables.dependabot.about-the-dependency-graph %}
You can export the current state of the dependency graph for your repository as a Software Bill of Materials (SBOM) using the industry standard [SPDX](https://spdx.github.io/spdx-spec/v2.3/) format.
You can export the current state of the dependency graph for your repository as a Software Bill of Materials (SBOM) using the industry standard [SPDX](https://spdx.github.io/spdx-spec/v2.3/) format:
- Via the {% data variables.product.prodname_dotcom %} UI
- Using the REST API
{% data reusables.dependency-graph.sbom-intro %}
@ -28,3 +30,7 @@ If your company provides software to the US federal government per [Executive Or
{% data reusables.repositories.accessing-repository-graphs %}
1. In the left sidebar, click **Dependency graph**.
1. On the top right side of the **Dependencies** tab, click **Export SBOM** to generate an SBOM file for download from your browser.
## Exporting a software bill of material for your repository using the REST API
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.

Просмотреть файл

@ -98,6 +98,7 @@ Alternatively, you can write your own action to submit dependencies for your pro
{% ifversion dependency-graph-sbom-export %}
To generate an SBOM, you can use:
- the {% data variables.product.prodname_dotcom %} user interface. For more information about how to export an SBOM for a repository using information from the dependency graph, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository)."
- the REST API. For more information, see "[AUTOTITLE](/rest/dependency-graph/sboms)."
- {% data variables.product.prodname_actions %}. The following actions will generate an SBOM for your repository and attach it as a workflow artifact which you can download and use in other applications. For more information about downloading workflow artifacts, see "[AUTOTITLE](/actions/managing-workflow-runs/downloading-workflow-artifacts)."
{% else %}
You can use {% data variables.product.prodname_actions %} to generate an SBOM. The following actions will generate an SBOM for your repository and attach it as a workflow artifact which you can download and use in other applications. For more information about downloading workflow artifacts, see "[AUTOTITLE](/actions/managing-workflow-runs/downloading-workflow-artifacts)."

Просмотреть файл

@ -10,5 +10,8 @@ topics:
autogenerated: rest
allowTitleToDifferFromFilename: true
---
{% data reusables.dependency-graph.sbom-export %}
This article gives details about the REST API endpoint.
<!-- Content after this section is automatically generated -->

Просмотреть файл

@ -1 +1 @@
If you have at least read access to the repository, you can export the dependency graph for the repository as an SPDX-compatible, Software Bill of Materials (SBOM). For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository)."
If you have at least read access to the repository, you can export the dependency graph for the repository as an SPDX-compatible, Software Bill of Materials (SBOM), via the {% data variables.product.prodname_dotcom %} UI or {% data variables.product.company_short %} REST API. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository)."