Skip to content

Commit 3ae8ad3

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #4993 from github/openapi-update-76fe1aab277b581ed3c198df636337045201a3ab2ac5c554475ee7d993603196
Update OpenAPI 3.1 Descriptions
2 parents 086badc + 30bb4d6 commit 3ae8ad3

16 files changed

+7632
-4932
lines changed

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

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70024,6 +70024,157 @@
7002470024
}
7002570025
}
7002670026
},
70027+
"/users/{username}/attestations/bulk-list": {
70028+
"post": {
70029+
"summary": "List attestations by bulk subject digests",
70030+
"description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).",
70031+
"tags": [
70032+
"users"
70033+
],
70034+
"operationId": "users/list-attestations-bulk",
70035+
"externalDocs": {
70036+
"description": "API method documentation",
70037+
"url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests"
70038+
},
70039+
"parameters": [
70040+
{
70041+
"$ref": "#/components/parameters/per-page"
70042+
},
70043+
{
70044+
"$ref": "#/components/parameters/pagination-before"
70045+
},
70046+
{
70047+
"$ref": "#/components/parameters/pagination-after"
70048+
},
70049+
{
70050+
"$ref": "#/components/parameters/username"
70051+
}
70052+
],
70053+
"requestBody": {
70054+
"required": true,
70055+
"content": {
70056+
"application/json": {
70057+
"schema": {
70058+
"type": "object",
70059+
"properties": {
70060+
"subject_digests": {
70061+
"type": "array",
70062+
"items": {
70063+
"type": "string"
70064+
},
70065+
"description": "List of subject digests to fetch attestations for.",
70066+
"minItems": 1,
70067+
"maxItems": 1024
70068+
},
70069+
"predicate_type": {
70070+
"type": "string",
70071+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types."
70072+
}
70073+
},
70074+
"required": [
70075+
"subject_digests"
70076+
]
70077+
},
70078+
"examples": {
70079+
"default": {
70080+
"$ref": "#/components/examples/bulk-subject-digest-body"
70081+
},
70082+
"withPredicateType": {
70083+
"$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type"
70084+
}
70085+
}
70086+
}
70087+
}
70088+
},
70089+
"responses": {
70090+
"200": {
70091+
"description": "Response",
70092+
"content": {
70093+
"application/json": {
70094+
"schema": {
70095+
"type": "object",
70096+
"properties": {
70097+
"attestations_subject_digests": {
70098+
"type": "object",
70099+
"additionalProperties": {
70100+
"type": [
70101+
"array",
70102+
"null"
70103+
],
70104+
"items": {
70105+
"type": "object",
70106+
"properties": {
70107+
"bundle": {
70108+
"type": "object",
70109+
"properties": {
70110+
"mediaType": {
70111+
"type": "string"
70112+
},
70113+
"verificationMaterial": {
70114+
"type": "object",
70115+
"properties": {},
70116+
"additionalProperties": true
70117+
},
70118+
"dsseEnvelope": {
70119+
"type": "object",
70120+
"properties": {},
70121+
"additionalProperties": true
70122+
}
70123+
},
70124+
"description": "The bundle of the attestation."
70125+
},
70126+
"repository_id": {
70127+
"type": "integer"
70128+
},
70129+
"bundle_url": {
70130+
"type": "string"
70131+
}
70132+
}
70133+
}
70134+
},
70135+
"description": "Mapping of subject digest to bundles."
70136+
},
70137+
"page_info": {
70138+
"type": "object",
70139+
"properties": {
70140+
"has_next": {
70141+
"type": "boolean",
70142+
"description": "Indicates whether there is a next page."
70143+
},
70144+
"has_previous": {
70145+
"type": "boolean",
70146+
"description": "Indicates whether there is a previous page."
70147+
},
70148+
"next": {
70149+
"type": "string",
70150+
"description": "The cursor to the next page."
70151+
},
70152+
"previous": {
70153+
"type": "string",
70154+
"description": "The cursor to the previous page."
70155+
}
70156+
},
70157+
"description": "Information about the current page."
70158+
}
70159+
}
70160+
},
70161+
"examples": {
70162+
"default": {
70163+
"$ref": "#/components/examples/list-attestations-bulk"
70164+
}
70165+
}
70166+
}
70167+
}
70168+
}
70169+
},
70170+
"x-github": {
70171+
"githubCloudOnly": false,
70172+
"enabledForGitHubApps": true,
70173+
"category": "users",
70174+
"subcategory": "attestations"
70175+
}
70176+
}
70177+
},
7002770178
"/users/{username}/attestations/delete-request": {
7002870179
"post": {
7002970180
"summary": "Delete attestations in bulk",

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

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50843,6 +50843,112 @@ paths:
5084350843
enabledForGitHubApps: true
5084450844
category: users
5084550845
subcategory: users
50846+
"/users/{username}/attestations/bulk-list":
50847+
post:
50848+
summary: List attestations by bulk subject digests
50849+
description: |-
50850+
List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.
50851+
50852+
The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.
50853+
50854+
**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
50855+
tags:
50856+
- users
50857+
operationId: users/list-attestations-bulk
50858+
externalDocs:
50859+
description: API method documentation
50860+
url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests
50861+
parameters:
50862+
- "$ref": "#/components/parameters/per-page"
50863+
- "$ref": "#/components/parameters/pagination-before"
50864+
- "$ref": "#/components/parameters/pagination-after"
50865+
- "$ref": "#/components/parameters/username"
50866+
requestBody:
50867+
required: true
50868+
content:
50869+
application/json:
50870+
schema:
50871+
type: object
50872+
properties:
50873+
subject_digests:
50874+
type: array
50875+
items:
50876+
type: string
50877+
description: List of subject digests to fetch attestations for.
50878+
minItems: 1
50879+
maxItems: 1024
50880+
predicate_type:
50881+
type: string
50882+
description: |-
50883+
Optional filter for fetching attestations with a given predicate type.
50884+
This option accepts `provenance`, `sbom`, or freeform text for custom predicate types.
50885+
required:
50886+
- subject_digests
50887+
examples:
50888+
default:
50889+
"$ref": "#/components/examples/bulk-subject-digest-body"
50890+
withPredicateType:
50891+
"$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type"
50892+
responses:
50893+
'200':
50894+
description: Response
50895+
content:
50896+
application/json:
50897+
schema:
50898+
type: object
50899+
properties:
50900+
attestations_subject_digests:
50901+
type: object
50902+
additionalProperties:
50903+
type:
50904+
- array
50905+
- 'null'
50906+
items:
50907+
type: object
50908+
properties:
50909+
bundle:
50910+
type: object
50911+
properties:
50912+
mediaType:
50913+
type: string
50914+
verificationMaterial:
50915+
type: object
50916+
properties: {}
50917+
additionalProperties: true
50918+
dsseEnvelope:
50919+
type: object
50920+
properties: {}
50921+
additionalProperties: true
50922+
description: The bundle of the attestation.
50923+
repository_id:
50924+
type: integer
50925+
bundle_url:
50926+
type: string
50927+
description: Mapping of subject digest to bundles.
50928+
page_info:
50929+
type: object
50930+
properties:
50931+
has_next:
50932+
type: boolean
50933+
description: Indicates whether there is a next page.
50934+
has_previous:
50935+
type: boolean
50936+
description: Indicates whether there is a previous page.
50937+
next:
50938+
type: string
50939+
description: The cursor to the next page.
50940+
previous:
50941+
type: string
50942+
description: The cursor to the previous page.
50943+
description: Information about the current page.
50944+
examples:
50945+
default:
50946+
"$ref": "#/components/examples/list-attestations-bulk"
50947+
x-github:
50948+
githubCloudOnly: false
50949+
enabledForGitHubApps: true
50950+
category: users
50951+
subcategory: attestations
5084650952
"/users/{username}/attestations/delete-request":
5084750953
post:
5084850954
summary: Delete attestations in bulk

0 commit comments

Comments
 (0)