Skip to content

Commit e1a4d85

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent 6165e61 commit e1a4d85

16 files changed

+7640
-4964
lines changed

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

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69661,6 +69661,155 @@
6966169661
}
6966269662
}
6966369663
},
69664+
"/users/{username}/attestations/bulk-list": {
69665+
"post": {
69666+
"summary": "List attestations by bulk subject digests",
69667+
"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).",
69668+
"tags": [
69669+
"users"
69670+
],
69671+
"operationId": "users/list-attestations-bulk",
69672+
"externalDocs": {
69673+
"description": "API method documentation",
69674+
"url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests"
69675+
},
69676+
"parameters": [
69677+
{
69678+
"$ref": "#/components/parameters/per-page"
69679+
},
69680+
{
69681+
"$ref": "#/components/parameters/pagination-before"
69682+
},
69683+
{
69684+
"$ref": "#/components/parameters/pagination-after"
69685+
},
69686+
{
69687+
"$ref": "#/components/parameters/username"
69688+
}
69689+
],
69690+
"requestBody": {
69691+
"required": true,
69692+
"content": {
69693+
"application/json": {
69694+
"schema": {
69695+
"type": "object",
69696+
"properties": {
69697+
"subject_digests": {
69698+
"type": "array",
69699+
"items": {
69700+
"type": "string"
69701+
},
69702+
"description": "List of subject digests to fetch attestations for.",
69703+
"minItems": 1,
69704+
"maxItems": 1024
69705+
},
69706+
"predicate_type": {
69707+
"type": "string",
69708+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types."
69709+
}
69710+
},
69711+
"required": [
69712+
"subject_digests"
69713+
]
69714+
},
69715+
"examples": {
69716+
"default": {
69717+
"$ref": "#/components/examples/bulk-subject-digest-body"
69718+
},
69719+
"withPredicateType": {
69720+
"$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type"
69721+
}
69722+
}
69723+
}
69724+
}
69725+
},
69726+
"responses": {
69727+
"200": {
69728+
"description": "Response",
69729+
"content": {
69730+
"application/json": {
69731+
"schema": {
69732+
"type": "object",
69733+
"properties": {
69734+
"attestations_subject_digests": {
69735+
"type": "object",
69736+
"additionalProperties": {
69737+
"nullable": true,
69738+
"type": "array",
69739+
"items": {
69740+
"type": "object",
69741+
"properties": {
69742+
"bundle": {
69743+
"type": "object",
69744+
"properties": {
69745+
"mediaType": {
69746+
"type": "string"
69747+
},
69748+
"verificationMaterial": {
69749+
"type": "object",
69750+
"properties": {},
69751+
"additionalProperties": true
69752+
},
69753+
"dsseEnvelope": {
69754+
"type": "object",
69755+
"properties": {},
69756+
"additionalProperties": true
69757+
}
69758+
},
69759+
"description": "The bundle of the attestation."
69760+
},
69761+
"repository_id": {
69762+
"type": "integer"
69763+
},
69764+
"bundle_url": {
69765+
"type": "string"
69766+
}
69767+
}
69768+
}
69769+
},
69770+
"description": "Mapping of subject digest to bundles."
69771+
},
69772+
"page_info": {
69773+
"type": "object",
69774+
"properties": {
69775+
"has_next": {
69776+
"type": "boolean",
69777+
"description": "Indicates whether there is a next page."
69778+
},
69779+
"has_previous": {
69780+
"type": "boolean",
69781+
"description": "Indicates whether there is a previous page."
69782+
},
69783+
"next": {
69784+
"type": "string",
69785+
"description": "The cursor to the next page."
69786+
},
69787+
"previous": {
69788+
"type": "string",
69789+
"description": "The cursor to the previous page."
69790+
}
69791+
},
69792+
"description": "Information about the current page."
69793+
}
69794+
}
69795+
},
69796+
"examples": {
69797+
"default": {
69798+
"$ref": "#/components/examples/list-attestations-bulk"
69799+
}
69800+
}
69801+
}
69802+
}
69803+
}
69804+
},
69805+
"x-github": {
69806+
"githubCloudOnly": false,
69807+
"enabledForGitHubApps": true,
69808+
"category": "users",
69809+
"subcategory": "attestations"
69810+
}
69811+
}
69812+
},
6966469813
"/users/{username}/attestations/delete-request": {
6966569814
"post": {
6966669815
"summary": "Delete attestations in bulk",

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

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50662,6 +50662,111 @@ paths:
5066250662
enabledForGitHubApps: true
5066350663
category: users
5066450664
subcategory: users
50665+
"/users/{username}/attestations/bulk-list":
50666+
post:
50667+
summary: List attestations by bulk subject digests
50668+
description: |-
50669+
List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.
50670+
50671+
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.
50672+
50673+
**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).
50674+
tags:
50675+
- users
50676+
operationId: users/list-attestations-bulk
50677+
externalDocs:
50678+
description: API method documentation
50679+
url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests
50680+
parameters:
50681+
- "$ref": "#/components/parameters/per-page"
50682+
- "$ref": "#/components/parameters/pagination-before"
50683+
- "$ref": "#/components/parameters/pagination-after"
50684+
- "$ref": "#/components/parameters/username"
50685+
requestBody:
50686+
required: true
50687+
content:
50688+
application/json:
50689+
schema:
50690+
type: object
50691+
properties:
50692+
subject_digests:
50693+
type: array
50694+
items:
50695+
type: string
50696+
description: List of subject digests to fetch attestations for.
50697+
minItems: 1
50698+
maxItems: 1024
50699+
predicate_type:
50700+
type: string
50701+
description: |-
50702+
Optional filter for fetching attestations with a given predicate type.
50703+
This option accepts `provenance`, `sbom`, or freeform text for custom predicate types.
50704+
required:
50705+
- subject_digests
50706+
examples:
50707+
default:
50708+
"$ref": "#/components/examples/bulk-subject-digest-body"
50709+
withPredicateType:
50710+
"$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type"
50711+
responses:
50712+
'200':
50713+
description: Response
50714+
content:
50715+
application/json:
50716+
schema:
50717+
type: object
50718+
properties:
50719+
attestations_subject_digests:
50720+
type: object
50721+
additionalProperties:
50722+
nullable: true
50723+
type: array
50724+
items:
50725+
type: object
50726+
properties:
50727+
bundle:
50728+
type: object
50729+
properties:
50730+
mediaType:
50731+
type: string
50732+
verificationMaterial:
50733+
type: object
50734+
properties: {}
50735+
additionalProperties: true
50736+
dsseEnvelope:
50737+
type: object
50738+
properties: {}
50739+
additionalProperties: true
50740+
description: The bundle of the attestation.
50741+
repository_id:
50742+
type: integer
50743+
bundle_url:
50744+
type: string
50745+
description: Mapping of subject digest to bundles.
50746+
page_info:
50747+
type: object
50748+
properties:
50749+
has_next:
50750+
type: boolean
50751+
description: Indicates whether there is a next page.
50752+
has_previous:
50753+
type: boolean
50754+
description: Indicates whether there is a previous page.
50755+
next:
50756+
type: string
50757+
description: The cursor to the next page.
50758+
previous:
50759+
type: string
50760+
description: The cursor to the previous page.
50761+
description: Information about the current page.
50762+
examples:
50763+
default:
50764+
"$ref": "#/components/examples/list-attestations-bulk"
50765+
x-github:
50766+
githubCloudOnly: false
50767+
enabledForGitHubApps: true
50768+
category: users
50769+
subcategory: attestations
5066550770
"/users/{username}/attestations/delete-request":
5066650771
post:
5066750772
summary: Delete attestations in bulk

0 commit comments

Comments
 (0)