Skip to content

Commit 6dcec4c

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent 9110306 commit 6dcec4c

24 files changed

+3040
-80
lines changed

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

Lines changed: 193 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10908,6 +10908,198 @@
1090810908
}
1090910909
}
1091010910
},
10911+
"/orgs/{org}/attestations/delete-request": {
10912+
"post": {
10913+
"summary": "Delete attestations in bulk",
10914+
"description": "Delete artifact attestations in bulk by either subject digests or unique ID.",
10915+
"tags": [
10916+
"orgs"
10917+
],
10918+
"operationId": "orgs/delete-attestations-bulk",
10919+
"externalDocs": {
10920+
"description": "API method documentation",
10921+
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk"
10922+
},
10923+
"parameters": [
10924+
{
10925+
"$ref": "#/components/parameters/org"
10926+
}
10927+
],
10928+
"requestBody": {
10929+
"required": true,
10930+
"content": {
10931+
"application/json": {
10932+
"schema": {
10933+
"type": "object",
10934+
"oneOf": [
10935+
{
10936+
"properties": {
10937+
"subject_digests": {
10938+
"type": "array",
10939+
"items": {
10940+
"type": "string"
10941+
},
10942+
"description": "List of subject digests associated with the artifact attestations to delete.",
10943+
"minItems": 1,
10944+
"maxItems": 1024
10945+
}
10946+
},
10947+
"required": [
10948+
"subject_digests"
10949+
]
10950+
},
10951+
{
10952+
"properties": {
10953+
"attestation_ids": {
10954+
"type": "array",
10955+
"items": {
10956+
"type": "integer"
10957+
},
10958+
"description": "List of unique IDs associated with the artifact attestations to delete.",
10959+
"minItems": 1,
10960+
"maxItems": 1024
10961+
}
10962+
},
10963+
"required": [
10964+
"attestation_ids"
10965+
]
10966+
}
10967+
],
10968+
"description": "The request body must include either `subject_digests` or `attestation_ids`, but not both."
10969+
},
10970+
"examples": {
10971+
"by-subject-digests": {
10972+
"summary": "Delete by subject digests",
10973+
"value": {
10974+
"subject_digests": [
10975+
"sha256:abc123",
10976+
"sha512:def456"
10977+
]
10978+
}
10979+
},
10980+
"by-attestation-ids": {
10981+
"summary": "Delete by attestation IDs",
10982+
"value": {
10983+
"attestation_ids": [
10984+
111,
10985+
222
10986+
]
10987+
}
10988+
}
10989+
}
10990+
}
10991+
}
10992+
},
10993+
"responses": {
10994+
"200": {
10995+
"description": "Response"
10996+
},
10997+
"404": {
10998+
"$ref": "#/components/responses/not_found"
10999+
}
11000+
},
11001+
"x-github": {
11002+
"githubCloudOnly": false,
11003+
"enabledForGitHubApps": true,
11004+
"category": "orgs",
11005+
"subcategory": "attestations"
11006+
}
11007+
}
11008+
},
11009+
"/orgs/{org}/attestations/digest/{subject_digest}": {
11010+
"delete": {
11011+
"summary": "Delete attestations by subject digest",
11012+
"description": "Delete an artifact attestation by subject digest.",
11013+
"tags": [
11014+
"orgs"
11015+
],
11016+
"operationId": "orgs/delete-attestations-by-subject-digest",
11017+
"externalDocs": {
11018+
"description": "API method documentation",
11019+
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest"
11020+
},
11021+
"parameters": [
11022+
{
11023+
"$ref": "#/components/parameters/org"
11024+
},
11025+
{
11026+
"name": "subject_digest",
11027+
"description": "Subject Digest",
11028+
"in": "path",
11029+
"required": true,
11030+
"schema": {
11031+
"type": "string"
11032+
},
11033+
"x-multi-segment": true
11034+
}
11035+
],
11036+
"responses": {
11037+
"200": {
11038+
"description": "Response"
11039+
},
11040+
"204": {
11041+
"description": "Response"
11042+
},
11043+
"404": {
11044+
"$ref": "#/components/responses/not_found"
11045+
}
11046+
},
11047+
"x-github": {
11048+
"githubCloudOnly": false,
11049+
"enabledForGitHubApps": true,
11050+
"category": "orgs",
11051+
"subcategory": "attestations"
11052+
}
11053+
}
11054+
},
11055+
"/orgs/{org}/attestations/{attestation_id}": {
11056+
"delete": {
11057+
"summary": "Delete attestations by ID",
11058+
"description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.",
11059+
"tags": [
11060+
"orgs"
11061+
],
11062+
"operationId": "orgs/delete-attestations-by-id",
11063+
"externalDocs": {
11064+
"description": "API method documentation",
11065+
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id"
11066+
},
11067+
"parameters": [
11068+
{
11069+
"$ref": "#/components/parameters/org"
11070+
},
11071+
{
11072+
"name": "attestation_id",
11073+
"description": "Attestation ID",
11074+
"in": "path",
11075+
"required": true,
11076+
"schema": {
11077+
"type": "integer"
11078+
}
11079+
}
11080+
],
11081+
"responses": {
11082+
"200": {
11083+
"description": "Response"
11084+
},
11085+
"204": {
11086+
"description": "Response"
11087+
},
11088+
"403": {
11089+
"$ref": "#/components/responses/forbidden"
11090+
},
11091+
"404": {
11092+
"$ref": "#/components/responses/not_found"
11093+
}
11094+
},
11095+
"x-github": {
11096+
"githubCloudOnly": false,
11097+
"enabledForGitHubApps": true,
11098+
"category": "orgs",
11099+
"subcategory": "attestations"
11100+
}
11101+
}
11102+
},
1091111103
"/orgs/{org}/attestations/{subject_digest}": {
1091211104
"get": {
1091311105
"summary": "List attestations",
@@ -69891,7 +70083,7 @@
6989170083
"by-attestation-ids": {
6989270084
"summary": "Delete by attestation IDs",
6989370085
"value": {
69894-
"subject_digests": [
70086+
"attestation_ids": [
6989570087
111,
6989670088
222
6989770089
]

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

Lines changed: 132 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7915,6 +7915,137 @@ paths:
79157915
enabledForGitHubApps: true
79167916
category: orgs
79177917
subcategory: orgs
7918+
"/orgs/{org}/attestations/delete-request":
7919+
post:
7920+
summary: Delete attestations in bulk
7921+
description: Delete artifact attestations in bulk by either subject digests
7922+
or unique ID.
7923+
tags:
7924+
- orgs
7925+
operationId: orgs/delete-attestations-bulk
7926+
externalDocs:
7927+
description: API method documentation
7928+
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk
7929+
parameters:
7930+
- "$ref": "#/components/parameters/org"
7931+
requestBody:
7932+
required: true
7933+
content:
7934+
application/json:
7935+
schema:
7936+
type: object
7937+
oneOf:
7938+
- properties:
7939+
subject_digests:
7940+
type: array
7941+
items:
7942+
type: string
7943+
description: List of subject digests associated with the artifact
7944+
attestations to delete.
7945+
minItems: 1
7946+
maxItems: 1024
7947+
required:
7948+
- subject_digests
7949+
- properties:
7950+
attestation_ids:
7951+
type: array
7952+
items:
7953+
type: integer
7954+
description: List of unique IDs associated with the artifact attestations
7955+
to delete.
7956+
minItems: 1
7957+
maxItems: 1024
7958+
required:
7959+
- attestation_ids
7960+
description: The request body must include either `subject_digests`
7961+
or `attestation_ids`, but not both.
7962+
examples:
7963+
by-subject-digests:
7964+
summary: Delete by subject digests
7965+
value:
7966+
subject_digests:
7967+
- sha256:abc123
7968+
- sha512:def456
7969+
by-attestation-ids:
7970+
summary: Delete by attestation IDs
7971+
value:
7972+
attestation_ids:
7973+
- 111
7974+
- 222
7975+
responses:
7976+
'200':
7977+
description: Response
7978+
'404':
7979+
"$ref": "#/components/responses/not_found"
7980+
x-github:
7981+
githubCloudOnly: false
7982+
enabledForGitHubApps: true
7983+
category: orgs
7984+
subcategory: attestations
7985+
"/orgs/{org}/attestations/digest/{subject_digest}":
7986+
delete:
7987+
summary: Delete attestations by subject digest
7988+
description: Delete an artifact attestation by subject digest.
7989+
tags:
7990+
- orgs
7991+
operationId: orgs/delete-attestations-by-subject-digest
7992+
externalDocs:
7993+
description: API method documentation
7994+
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest
7995+
parameters:
7996+
- "$ref": "#/components/parameters/org"
7997+
- name: subject_digest
7998+
description: Subject Digest
7999+
in: path
8000+
required: true
8001+
schema:
8002+
type: string
8003+
x-multi-segment: true
8004+
responses:
8005+
'200':
8006+
description: Response
8007+
'204':
8008+
description: Response
8009+
'404':
8010+
"$ref": "#/components/responses/not_found"
8011+
x-github:
8012+
githubCloudOnly: false
8013+
enabledForGitHubApps: true
8014+
category: orgs
8015+
subcategory: attestations
8016+
"/orgs/{org}/attestations/{attestation_id}":
8017+
delete:
8018+
summary: Delete attestations by ID
8019+
description: Delete an artifact attestation by unique ID that is associated
8020+
with a repository owned by an org.
8021+
tags:
8022+
- orgs
8023+
operationId: orgs/delete-attestations-by-id
8024+
externalDocs:
8025+
description: API method documentation
8026+
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id
8027+
parameters:
8028+
- "$ref": "#/components/parameters/org"
8029+
- name: attestation_id
8030+
description: Attestation ID
8031+
in: path
8032+
required: true
8033+
schema:
8034+
type: integer
8035+
responses:
8036+
'200':
8037+
description: Response
8038+
'204':
8039+
description: Response
8040+
'403':
8041+
"$ref": "#/components/responses/forbidden"
8042+
'404':
8043+
"$ref": "#/components/responses/not_found"
8044+
x-github:
8045+
githubCloudOnly: false
8046+
enabledForGitHubApps: true
8047+
category: orgs
8048+
subcategory: attestations
79188049
"/orgs/{org}/attestations/{subject_digest}":
79198050
get:
79208051
summary: List attestations
@@ -50755,7 +50886,7 @@ paths:
5075550886
by-attestation-ids:
5075650887
summary: Delete by attestation IDs
5075750888
value:
50758-
subject_digests:
50889+
attestation_ids:
5075950890
- 111
5076050891
- 222
5076150892
responses:

0 commit comments

Comments
 (0)