Skip to content

Commit 0c5ca16

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #6287 from github/openapi-update-9d2ecc3591d94bb25415a66834cfdb81ba1e07725d07c231352dcba5d70e91af
Update OpenAPI 3.0 Descriptions
2 parents e6a3456 + e9caf9d commit 0c5ca16

24 files changed

Lines changed: 15754 additions & 12772 deletions

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

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47369,6 +47369,117 @@
4736947369
}
4737047370
}
4737147371
},
47372+
"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}": {
47373+
"get": {
47374+
"summary": "Fetch a software bill of materials (SBOM) for a repository.",
47375+
"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.",
47376+
"tags": [
47377+
"dependency-graph"
47378+
],
47379+
"operationId": "dependency-graph/fetch-sbom-report",
47380+
"externalDocs": {
47381+
"description": "API method documentation",
47382+
"url": "https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository"
47383+
},
47384+
"parameters": [
47385+
{
47386+
"$ref": "#/components/parameters/owner"
47387+
},
47388+
{
47389+
"$ref": "#/components/parameters/repo"
47390+
},
47391+
{
47392+
"name": "sbom_uuid",
47393+
"in": "path",
47394+
"required": true,
47395+
"description": "The unique identifier of the SBOM export.",
47396+
"schema": {
47397+
"type": "string"
47398+
}
47399+
}
47400+
],
47401+
"responses": {
47402+
"302": {
47403+
"description": "Redirects to a temporary download URL for the completed SBOM.",
47404+
"headers": {
47405+
"Location": {
47406+
"$ref": "#/components/headers/location"
47407+
}
47408+
}
47409+
},
47410+
"202": {
47411+
"description": "SBOM is still being processed, no content is returned."
47412+
},
47413+
"404": {
47414+
"$ref": "#/components/responses/not_found"
47415+
},
47416+
"403": {
47417+
"$ref": "#/components/responses/forbidden"
47418+
}
47419+
},
47420+
"x-github": {
47421+
"githubCloudOnly": false,
47422+
"category": "dependency-graph",
47423+
"subcategory": "sboms"
47424+
}
47425+
}
47426+
},
47427+
"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report": {
47428+
"get": {
47429+
"summary": "Request generation of a software bill of materials (SBOM) for a repository.",
47430+
"description": "Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.",
47431+
"tags": [
47432+
"dependency-graph"
47433+
],
47434+
"operationId": "dependency-graph/generate-sbom-report",
47435+
"externalDocs": {
47436+
"description": "API method documentation",
47437+
"url": "https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository"
47438+
},
47439+
"parameters": [
47440+
{
47441+
"$ref": "#/components/parameters/owner"
47442+
},
47443+
{
47444+
"$ref": "#/components/parameters/repo"
47445+
}
47446+
],
47447+
"responses": {
47448+
"201": {
47449+
"description": "Response",
47450+
"content": {
47451+
"application/json": {
47452+
"schema": {
47453+
"type": "object",
47454+
"properties": {
47455+
"sbom_url": {
47456+
"type": "string",
47457+
"description": "URL to poll for the SBOM export result."
47458+
}
47459+
}
47460+
},
47461+
"examples": {
47462+
"default": {
47463+
"$ref": "#/components/examples/dependency-graph-generate-sbom-report-response"
47464+
}
47465+
}
47466+
}
47467+
}
47468+
},
47469+
"404": {
47470+
"$ref": "#/components/responses/not_found"
47471+
},
47472+
"403": {
47473+
"$ref": "#/components/responses/forbidden"
47474+
}
47475+
},
47476+
"x-github": {
47477+
"githubCloudOnly": false,
47478+
"category": "dependency-graph",
47479+
"subcategory": "sboms"
47480+
}
47481+
}
47482+
},
4737247483
"/repos/{owner}/{repo}/dependency-graph/snapshots": {
4737347484
"post": {
4737447485
"summary": "Create a snapshot of dependencies for a repository",
@@ -305272,6 +305383,11 @@
305272305383
}
305273305384
}
305274305385
},
305386+
"dependency-graph-generate-sbom-report-response": {
305387+
"value": {
305388+
"sbom_url": "https://api.github.com/repos/github/example/dependency-graph/sbom/fetch-report/4bab1a7e-da63-4828-9488-44e0e01a7c1b"
305389+
}
305390+
},
305275305391
"dependency-graph-create-snapshot-request": {
305276305392
"value": {
305277305393
"version": 0,

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

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34558,6 +34558,81 @@ paths:
3455834558
githubCloudOnly: false
3455934559
category: dependency-graph
3456034560
subcategory: sboms
34561+
"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}":
34562+
get:
34563+
summary: Fetch a software bill of materials (SBOM) for a repository.
34564+
description: |-
34565+
Fetches a previously generated software bill of materials (SBOM) for a repository.
34566+
When the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format.
34567+
The generated SBOM report may be retained for up to one week from the original request.
34568+
The temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.
34569+
tags:
34570+
- dependency-graph
34571+
operationId: dependency-graph/fetch-sbom-report
34572+
externalDocs:
34573+
description: API method documentation
34574+
url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository
34575+
parameters:
34576+
- "$ref": "#/components/parameters/owner"
34577+
- "$ref": "#/components/parameters/repo"
34578+
- name: sbom_uuid
34579+
in: path
34580+
required: true
34581+
description: The unique identifier of the SBOM export.
34582+
schema:
34583+
type: string
34584+
responses:
34585+
'302':
34586+
description: Redirects to a temporary download URL for the completed SBOM.
34587+
headers:
34588+
Location:
34589+
"$ref": "#/components/headers/location"
34590+
'202':
34591+
description: SBOM is still being processed, no content is returned.
34592+
'404':
34593+
"$ref": "#/components/responses/not_found"
34594+
'403':
34595+
"$ref": "#/components/responses/forbidden"
34596+
x-github:
34597+
githubCloudOnly: false
34598+
category: dependency-graph
34599+
subcategory: sboms
34600+
"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report":
34601+
get:
34602+
summary: Request generation of a software bill of materials (SBOM) for a repository.
34603+
description: Triggers a job to generate a software bill of materials (SBOM)
34604+
for a repository in SPDX JSON format.
34605+
tags:
34606+
- dependency-graph
34607+
operationId: dependency-graph/generate-sbom-report
34608+
externalDocs:
34609+
description: API method documentation
34610+
url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository
34611+
parameters:
34612+
- "$ref": "#/components/parameters/owner"
34613+
- "$ref": "#/components/parameters/repo"
34614+
responses:
34615+
'201':
34616+
description: Response
34617+
content:
34618+
application/json:
34619+
schema:
34620+
type: object
34621+
properties:
34622+
sbom_url:
34623+
type: string
34624+
description: URL to poll for the SBOM export result.
34625+
examples:
34626+
default:
34627+
"$ref": "#/components/examples/dependency-graph-generate-sbom-report-response"
34628+
'404':
34629+
"$ref": "#/components/responses/not_found"
34630+
'403':
34631+
"$ref": "#/components/responses/forbidden"
34632+
x-github:
34633+
githubCloudOnly: false
34634+
category: dependency-graph
34635+
subcategory: sboms
3456134636
"/repos/{owner}/{repo}/dependency-graph/snapshots":
3456234637
post:
3456334638
summary: Create a snapshot of dependencies for a repository
@@ -230155,6 +230230,9 @@ components:
230155230230
- relationshipType: DESCRIBES
230156230231
spdxElementId: SPDXRef-DOCUMENT
230157230232
relatedSpdxElement: SPDXRef-Repository
230233+
dependency-graph-generate-sbom-report-response:
230234+
value:
230235+
sbom_url: https://api.github.com/repos/github/example/dependency-graph/sbom/fetch-report/4bab1a7e-da63-4828-9488-44e0e01a7c1b
230158230236
dependency-graph-create-snapshot-request:
230159230237
value:
230160230238
version: 0

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

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47291,6 +47291,117 @@
4729147291
}
4729247292
}
4729347293
},
47294+
"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}": {
47295+
"get": {
47296+
"summary": "Fetch a software bill of materials (SBOM) for a repository.",
47297+
"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.",
47298+
"tags": [
47299+
"dependency-graph"
47300+
],
47301+
"operationId": "dependency-graph/fetch-sbom-report",
47302+
"externalDocs": {
47303+
"description": "API method documentation",
47304+
"url": "https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository"
47305+
},
47306+
"parameters": [
47307+
{
47308+
"$ref": "#/components/parameters/owner"
47309+
},
47310+
{
47311+
"$ref": "#/components/parameters/repo"
47312+
},
47313+
{
47314+
"name": "sbom_uuid",
47315+
"in": "path",
47316+
"required": true,
47317+
"description": "The unique identifier of the SBOM export.",
47318+
"schema": {
47319+
"type": "string"
47320+
}
47321+
}
47322+
],
47323+
"responses": {
47324+
"302": {
47325+
"description": "Redirects to a temporary download URL for the completed SBOM.",
47326+
"headers": {
47327+
"Location": {
47328+
"$ref": "#/components/headers/location"
47329+
}
47330+
}
47331+
},
47332+
"202": {
47333+
"description": "SBOM is still being processed, no content is returned."
47334+
},
47335+
"404": {
47336+
"$ref": "#/components/responses/not_found"
47337+
},
47338+
"403": {
47339+
"$ref": "#/components/responses/forbidden"
47340+
}
47341+
},
47342+
"x-github": {
47343+
"githubCloudOnly": false,
47344+
"category": "dependency-graph",
47345+
"subcategory": "sboms"
47346+
}
47347+
}
47348+
},
47349+
"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report": {
47350+
"get": {
47351+
"summary": "Request generation of a software bill of materials (SBOM) for a repository.",
47352+
"description": "Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.",
47353+
"tags": [
47354+
"dependency-graph"
47355+
],
47356+
"operationId": "dependency-graph/generate-sbom-report",
47357+
"externalDocs": {
47358+
"description": "API method documentation",
47359+
"url": "https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository"
47360+
},
47361+
"parameters": [
47362+
{
47363+
"$ref": "#/components/parameters/owner"
47364+
},
47365+
{
47366+
"$ref": "#/components/parameters/repo"
47367+
}
47368+
],
47369+
"responses": {
47370+
"201": {
47371+
"description": "Response",
47372+
"content": {
47373+
"application/json": {
47374+
"schema": {
47375+
"type": "object",
47376+
"properties": {
47377+
"sbom_url": {
47378+
"type": "string",
47379+
"description": "URL to poll for the SBOM export result."
47380+
}
47381+
}
47382+
},
47383+
"examples": {
47384+
"default": {
47385+
"$ref": "#/components/examples/dependency-graph-generate-sbom-report-response"
47386+
}
47387+
}
47388+
}
47389+
}
47390+
},
47391+
"404": {
47392+
"$ref": "#/components/responses/not_found"
47393+
},
47394+
"403": {
47395+
"$ref": "#/components/responses/forbidden"
47396+
}
47397+
},
47398+
"x-github": {
47399+
"githubCloudOnly": false,
47400+
"category": "dependency-graph",
47401+
"subcategory": "sboms"
47402+
}
47403+
}
47404+
},
4729447405
"/repos/{owner}/{repo}/dependency-graph/snapshots": {
4729547406
"post": {
4729647407
"summary": "Create a snapshot of dependencies for a repository",
@@ -304507,6 +304618,11 @@
304507304618
}
304508304619
}
304509304620
},
304621+
"dependency-graph-generate-sbom-report-response": {
304622+
"value": {
304623+
"sbom_url": "https://api.github.com/repos/github/example/dependency-graph/sbom/fetch-report/4bab1a7e-da63-4828-9488-44e0e01a7c1b"
304624+
}
304625+
},
304510304626
"dependency-graph-create-snapshot-request": {
304511304627
"value": {
304512304628
"version": 0,

0 commit comments

Comments
 (0)