Skip to content

Commit b8cc3c7

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #6288 from github/openapi-update-125151e8ba273f6ea1cef083a657fc6e8b6d9a786da67180e9caff8a1bb54e6c
Update OpenAPI 3.1 Descriptions
2 parents 0c5ca16 + 14f369d commit b8cc3c7

24 files changed

Lines changed: 15518 additions & 12536 deletions

‎descriptions-next/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47577,6 +47577,117 @@
4757747577
}
4757847578
}
4757947579
},
47580+
"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}": {
47581+
"get": {
47582+
"summary": "Fetch a software bill of materials (SBOM) for a repository.",
47583+
"description": "Fetches a previously generated software bill of materials (SBOM) for a repository.\nWhen the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format.\nThe generated SBOM report may be retained for up to one week from the original request.\nThe temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.",
47584+
"tags": [
47585+
"dependency-graph"
47586+
],
47587+
"operationId": "dependency-graph/fetch-sbom-report",
47588+
"externalDocs": {
47589+
"description": "API method documentation",
47590+
"url": "https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository"
47591+
},
47592+
"parameters": [
47593+
{
47594+
"$ref": "#/components/parameters/owner"
47595+
},
47596+
{
47597+
"$ref": "#/components/parameters/repo"
47598+
},
47599+
{
47600+
"name": "sbom_uuid",
47601+
"in": "path",
47602+
"required": true,
47603+
"description": "The unique identifier of the SBOM export.",
47604+
"schema": {
47605+
"type": "string"
47606+
}
47607+
}
47608+
],
47609+
"responses": {
47610+
"302": {
47611+
"description": "Redirects to a temporary download URL for the completed SBOM.",
47612+
"headers": {
47613+
"Location": {
47614+
"$ref": "#/components/headers/location"
47615+
}
47616+
}
47617+
},
47618+
"202": {
47619+
"description": "SBOM is still being processed, no content is returned."
47620+
},
47621+
"404": {
47622+
"$ref": "#/components/responses/not_found"
47623+
},
47624+
"403": {
47625+
"$ref": "#/components/responses/forbidden"
47626+
}
47627+
},
47628+
"x-github": {
47629+
"githubCloudOnly": false,
47630+
"category": "dependency-graph",
47631+
"subcategory": "sboms"
47632+
}
47633+
}
47634+
},
47635+
"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report": {
47636+
"get": {
47637+
"summary": "Request generation of a software bill of materials (SBOM) for a repository.",
47638+
"description": "Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.",
47639+
"tags": [
47640+
"dependency-graph"
47641+
],
47642+
"operationId": "dependency-graph/generate-sbom-report",
47643+
"externalDocs": {
47644+
"description": "API method documentation",
47645+
"url": "https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository"
47646+
},
47647+
"parameters": [
47648+
{
47649+
"$ref": "#/components/parameters/owner"
47650+
},
47651+
{
47652+
"$ref": "#/components/parameters/repo"
47653+
}
47654+
],
47655+
"responses": {
47656+
"201": {
47657+
"description": "Response",
47658+
"content": {
47659+
"application/json": {
47660+
"schema": {
47661+
"type": "object",
47662+
"properties": {
47663+
"sbom_url": {
47664+
"type": "string",
47665+
"description": "URL to poll for the SBOM export result."
47666+
}
47667+
}
47668+
},
47669+
"examples": {
47670+
"default": {
47671+
"$ref": "#/components/examples/dependency-graph-generate-sbom-report-response"
47672+
}
47673+
}
47674+
}
47675+
}
47676+
},
47677+
"404": {
47678+
"$ref": "#/components/responses/not_found"
47679+
},
47680+
"403": {
47681+
"$ref": "#/components/responses/forbidden"
47682+
}
47683+
},
47684+
"x-github": {
47685+
"githubCloudOnly": false,
47686+
"category": "dependency-graph",
47687+
"subcategory": "sboms"
47688+
}
47689+
}
47690+
},
4758047691
"/repos/{owner}/{repo}/dependency-graph/snapshots": {
4758147692
"post": {
4758247693
"summary": "Create a snapshot of dependencies for a repository",
@@ -314345,6 +314456,11 @@
314345314456
}
314346314457
}
314347314458
},
314459+
"dependency-graph-generate-sbom-report-response": {
314460+
"value": {
314461+
"sbom_url": "https://api.github.com/repos/github/example/dependency-graph/sbom/fetch-report/4bab1a7e-da63-4828-9488-44e0e01a7c1b"
314462+
}
314463+
},
314348314464
"dependency-graph-create-snapshot-request": {
314349314465
"value": {
314350314466
"version": 0,

‎descriptions-next/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34661,6 +34661,81 @@ paths:
3466134661
githubCloudOnly: false
3466234662
category: dependency-graph
3466334663
subcategory: sboms
34664+
"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}":
34665+
get:
34666+
summary: Fetch a software bill of materials (SBOM) for a repository.
34667+
description: |-
34668+
Fetches a previously generated software bill of materials (SBOM) for a repository.
34669+
When the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format.
34670+
The generated SBOM report may be retained for up to one week from the original request.
34671+
The temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.
34672+
tags:
34673+
- dependency-graph
34674+
operationId: dependency-graph/fetch-sbom-report
34675+
externalDocs:
34676+
description: API method documentation
34677+
url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository
34678+
parameters:
34679+
- "$ref": "#/components/parameters/owner"
34680+
- "$ref": "#/components/parameters/repo"
34681+
- name: sbom_uuid
34682+
in: path
34683+
required: true
34684+
description: The unique identifier of the SBOM export.
34685+
schema:
34686+
type: string
34687+
responses:
34688+
'302':
34689+
description: Redirects to a temporary download URL for the completed SBOM.
34690+
headers:
34691+
Location:
34692+
"$ref": "#/components/headers/location"
34693+
'202':
34694+
description: SBOM is still being processed, no content is returned.
34695+
'404':
34696+
"$ref": "#/components/responses/not_found"
34697+
'403':
34698+
"$ref": "#/components/responses/forbidden"
34699+
x-github:
34700+
githubCloudOnly: false
34701+
category: dependency-graph
34702+
subcategory: sboms
34703+
"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report":
34704+
get:
34705+
summary: Request generation of a software bill of materials (SBOM) for a repository.
34706+
description: Triggers a job to generate a software bill of materials (SBOM)
34707+
for a repository in SPDX JSON format.
34708+
tags:
34709+
- dependency-graph
34710+
operationId: dependency-graph/generate-sbom-report
34711+
externalDocs:
34712+
description: API method documentation
34713+
url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository
34714+
parameters:
34715+
- "$ref": "#/components/parameters/owner"
34716+
- "$ref": "#/components/parameters/repo"
34717+
responses:
34718+
'201':
34719+
description: Response
34720+
content:
34721+
application/json:
34722+
schema:
34723+
type: object
34724+
properties:
34725+
sbom_url:
34726+
type: string
34727+
description: URL to poll for the SBOM export result.
34728+
examples:
34729+
default:
34730+
"$ref": "#/components/examples/dependency-graph-generate-sbom-report-response"
34731+
'404':
34732+
"$ref": "#/components/responses/not_found"
34733+
'403':
34734+
"$ref": "#/components/responses/forbidden"
34735+
x-github:
34736+
githubCloudOnly: false
34737+
category: dependency-graph
34738+
subcategory: sboms
3466434739
"/repos/{owner}/{repo}/dependency-graph/snapshots":
3466534740
post:
3466634741
summary: Create a snapshot of dependencies for a repository
@@ -233383,6 +233458,9 @@ components:
233383233458
- relationshipType: DESCRIBES
233384233459
spdxElementId: SPDXRef-DOCUMENT
233385233460
relatedSpdxElement: SPDXRef-Repository
233461+
dependency-graph-generate-sbom-report-response:
233462+
value:
233463+
sbom_url: https://api.github.com/repos/github/example/dependency-graph/sbom/fetch-report/4bab1a7e-da63-4828-9488-44e0e01a7c1b
233386233464
dependency-graph-create-snapshot-request:
233387233465
value:
233388233466
version: 0

‎descriptions-next/api.github.com/api.github.com.2026-03-10.json‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47497,6 +47497,117 @@
4749747497
}
4749847498
}
4749947499
},
47500+
"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}": {
47501+
"get": {
47502+
"summary": "Fetch a software bill of materials (SBOM) for a repository.",
47503+
"description": "Fetches a previously generated software bill of materials (SBOM) for a repository.\nWhen the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format.\nThe generated SBOM report may be retained for up to one week from the original request.\nThe temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.",
47504+
"tags": [
47505+
"dependency-graph"
47506+
],
47507+
"operationId": "dependency-graph/fetch-sbom-report",
47508+
"externalDocs": {
47509+
"description": "API method documentation",
47510+
"url": "https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository"
47511+
},
47512+
"parameters": [
47513+
{
47514+
"$ref": "#/components/parameters/owner"
47515+
},
47516+
{
47517+
"$ref": "#/components/parameters/repo"
47518+
},
47519+
{
47520+
"name": "sbom_uuid",
47521+
"in": "path",
47522+
"required": true,
47523+
"description": "The unique identifier of the SBOM export.",
47524+
"schema": {
47525+
"type": "string"
47526+
}
47527+
}
47528+
],
47529+
"responses": {
47530+
"302": {
47531+
"description": "Redirects to a temporary download URL for the completed SBOM.",
47532+
"headers": {
47533+
"Location": {
47534+
"$ref": "#/components/headers/location"
47535+
}
47536+
}
47537+
},
47538+
"202": {
47539+
"description": "SBOM is still being processed, no content is returned."
47540+
},
47541+
"404": {
47542+
"$ref": "#/components/responses/not_found"
47543+
},
47544+
"403": {
47545+
"$ref": "#/components/responses/forbidden"
47546+
}
47547+
},
47548+
"x-github": {
47549+
"githubCloudOnly": false,
47550+
"category": "dependency-graph",
47551+
"subcategory": "sboms"
47552+
}
47553+
}
47554+
},
47555+
"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report": {
47556+
"get": {
47557+
"summary": "Request generation of a software bill of materials (SBOM) for a repository.",
47558+
"description": "Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.",
47559+
"tags": [
47560+
"dependency-graph"
47561+
],
47562+
"operationId": "dependency-graph/generate-sbom-report",
47563+
"externalDocs": {
47564+
"description": "API method documentation",
47565+
"url": "https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository"
47566+
},
47567+
"parameters": [
47568+
{
47569+
"$ref": "#/components/parameters/owner"
47570+
},
47571+
{
47572+
"$ref": "#/components/parameters/repo"
47573+
}
47574+
],
47575+
"responses": {
47576+
"201": {
47577+
"description": "Response",
47578+
"content": {
47579+
"application/json": {
47580+
"schema": {
47581+
"type": "object",
47582+
"properties": {
47583+
"sbom_url": {
47584+
"type": "string",
47585+
"description": "URL to poll for the SBOM export result."
47586+
}
47587+
}
47588+
},
47589+
"examples": {
47590+
"default": {
47591+
"$ref": "#/components/examples/dependency-graph-generate-sbom-report-response"
47592+
}
47593+
}
47594+
}
47595+
}
47596+
},
47597+
"404": {
47598+
"$ref": "#/components/responses/not_found"
47599+
},
47600+
"403": {
47601+
"$ref": "#/components/responses/forbidden"
47602+
}
47603+
},
47604+
"x-github": {
47605+
"githubCloudOnly": false,
47606+
"category": "dependency-graph",
47607+
"subcategory": "sboms"
47608+
}
47609+
}
47610+
},
4750047611
"/repos/{owner}/{repo}/dependency-graph/snapshots": {
4750147612
"post": {
4750247613
"summary": "Create a snapshot of dependencies for a repository",
@@ -313485,6 +313596,11 @@
313485313596
}
313486313597
}
313487313598
},
313599+
"dependency-graph-generate-sbom-report-response": {
313600+
"value": {
313601+
"sbom_url": "https://api.github.com/repos/github/example/dependency-graph/sbom/fetch-report/4bab1a7e-da63-4828-9488-44e0e01a7c1b"
313602+
}
313603+
},
313488313604
"dependency-graph-create-snapshot-request": {
313489313605
"value": {
313490313606
"version": 0,

0 commit comments

Comments
 (0)