Skip to content

Commit eb743c0

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent 9110306 commit eb743c0

24 files changed

+3040
-80
lines changed

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

Lines changed: 193 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10858,6 +10858,198 @@
1085810858
}
1085910859
}
1086010860
},
10861+
"/orgs/{org}/attestations/delete-request": {
10862+
"post": {
10863+
"summary": "Delete attestations in bulk",
10864+
"description": "Delete artifact attestations in bulk by either subject digests or unique ID.",
10865+
"tags": [
10866+
"orgs"
10867+
],
10868+
"operationId": "orgs/delete-attestations-bulk",
10869+
"externalDocs": {
10870+
"description": "API method documentation",
10871+
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk"
10872+
},
10873+
"parameters": [
10874+
{
10875+
"$ref": "#/components/parameters/org"
10876+
}
10877+
],
10878+
"requestBody": {
10879+
"required": true,
10880+
"content": {
10881+
"application/json": {
10882+
"schema": {
10883+
"type": "object",
10884+
"oneOf": [
10885+
{
10886+
"properties": {
10887+
"subject_digests": {
10888+
"type": "array",
10889+
"items": {
10890+
"type": "string"
10891+
},
10892+
"description": "List of subject digests associated with the artifact attestations to delete.",
10893+
"minItems": 1,
10894+
"maxItems": 1024
10895+
}
10896+
},
10897+
"required": [
10898+
"subject_digests"
10899+
]
10900+
},
10901+
{
10902+
"properties": {
10903+
"attestation_ids": {
10904+
"type": "array",
10905+
"items": {
10906+
"type": "integer"
10907+
},
10908+
"description": "List of unique IDs associated with the artifact attestations to delete.",
10909+
"minItems": 1,
10910+
"maxItems": 1024
10911+
}
10912+
},
10913+
"required": [
10914+
"attestation_ids"
10915+
]
10916+
}
10917+
],
10918+
"description": "The request body must include either `subject_digests` or `attestation_ids`, but not both."
10919+
},
10920+
"examples": {
10921+
"by-subject-digests": {
10922+
"summary": "Delete by subject digests",
10923+
"value": {
10924+
"subject_digests": [
10925+
"sha256:abc123",
10926+
"sha512:def456"
10927+
]
10928+
}
10929+
},
10930+
"by-attestation-ids": {
10931+
"summary": "Delete by attestation IDs",
10932+
"value": {
10933+
"attestation_ids": [
10934+
111,
10935+
222
10936+
]
10937+
}
10938+
}
10939+
}
10940+
}
10941+
}
10942+
},
10943+
"responses": {
10944+
"200": {
10945+
"description": "Response"
10946+
},
10947+
"404": {
10948+
"$ref": "#/components/responses/not_found"
10949+
}
10950+
},
10951+
"x-github": {
10952+
"githubCloudOnly": false,
10953+
"enabledForGitHubApps": true,
10954+
"category": "orgs",
10955+
"subcategory": "attestations"
10956+
}
10957+
}
10958+
},
10959+
"/orgs/{org}/attestations/digest/{subject_digest}": {
10960+
"delete": {
10961+
"summary": "Delete attestations by subject digest",
10962+
"description": "Delete an artifact attestation by subject digest.",
10963+
"tags": [
10964+
"orgs"
10965+
],
10966+
"operationId": "orgs/delete-attestations-by-subject-digest",
10967+
"externalDocs": {
10968+
"description": "API method documentation",
10969+
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest"
10970+
},
10971+
"parameters": [
10972+
{
10973+
"$ref": "#/components/parameters/org"
10974+
},
10975+
{
10976+
"name": "subject_digest",
10977+
"description": "Subject Digest",
10978+
"in": "path",
10979+
"required": true,
10980+
"schema": {
10981+
"type": "string"
10982+
},
10983+
"x-multi-segment": true
10984+
}
10985+
],
10986+
"responses": {
10987+
"200": {
10988+
"description": "Response"
10989+
},
10990+
"204": {
10991+
"description": "Response"
10992+
},
10993+
"404": {
10994+
"$ref": "#/components/responses/not_found"
10995+
}
10996+
},
10997+
"x-github": {
10998+
"githubCloudOnly": false,
10999+
"enabledForGitHubApps": true,
11000+
"category": "orgs",
11001+
"subcategory": "attestations"
11002+
}
11003+
}
11004+
},
11005+
"/orgs/{org}/attestations/{attestation_id}": {
11006+
"delete": {
11007+
"summary": "Delete attestations by ID",
11008+
"description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.",
11009+
"tags": [
11010+
"orgs"
11011+
],
11012+
"operationId": "orgs/delete-attestations-by-id",
11013+
"externalDocs": {
11014+
"description": "API method documentation",
11015+
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id"
11016+
},
11017+
"parameters": [
11018+
{
11019+
"$ref": "#/components/parameters/org"
11020+
},
11021+
{
11022+
"name": "attestation_id",
11023+
"description": "Attestation ID",
11024+
"in": "path",
11025+
"required": true,
11026+
"schema": {
11027+
"type": "integer"
11028+
}
11029+
}
11030+
],
11031+
"responses": {
11032+
"200": {
11033+
"description": "Response"
11034+
},
11035+
"204": {
11036+
"description": "Response"
11037+
},
11038+
"403": {
11039+
"$ref": "#/components/responses/forbidden"
11040+
},
11041+
"404": {
11042+
"$ref": "#/components/responses/not_found"
11043+
}
11044+
},
11045+
"x-github": {
11046+
"githubCloudOnly": false,
11047+
"enabledForGitHubApps": true,
11048+
"category": "orgs",
11049+
"subcategory": "attestations"
11050+
}
11051+
}
11052+
},
1086111053
"/orgs/{org}/attestations/{subject_digest}": {
1086211054
"get": {
1086311055
"summary": "List attestations",
@@ -69528,7 +69720,7 @@
6952869720
"by-attestation-ids": {
6952969721
"summary": "Delete by attestation IDs",
6953069722
"value": {
69531-
"subject_digests": [
69723+
"attestation_ids": [
6953269724
111,
6953369725
222
6953469726
]

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

Lines changed: 132 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7892,6 +7892,137 @@ paths:
78927892
enabledForGitHubApps: true
78937893
category: orgs
78947894
subcategory: orgs
7895+
"/orgs/{org}/attestations/delete-request":
7896+
post:
7897+
summary: Delete attestations in bulk
7898+
description: Delete artifact attestations in bulk by either subject digests
7899+
or unique ID.
7900+
tags:
7901+
- orgs
7902+
operationId: orgs/delete-attestations-bulk
7903+
externalDocs:
7904+
description: API method documentation
7905+
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk
7906+
parameters:
7907+
- "$ref": "#/components/parameters/org"
7908+
requestBody:
7909+
required: true
7910+
content:
7911+
application/json:
7912+
schema:
7913+
type: object
7914+
oneOf:
7915+
- properties:
7916+
subject_digests:
7917+
type: array
7918+
items:
7919+
type: string
7920+
description: List of subject digests associated with the artifact
7921+
attestations to delete.
7922+
minItems: 1
7923+
maxItems: 1024
7924+
required:
7925+
- subject_digests
7926+
- properties:
7927+
attestation_ids:
7928+
type: array
7929+
items:
7930+
type: integer
7931+
description: List of unique IDs associated with the artifact attestations
7932+
to delete.
7933+
minItems: 1
7934+
maxItems: 1024
7935+
required:
7936+
- attestation_ids
7937+
description: The request body must include either `subject_digests`
7938+
or `attestation_ids`, but not both.
7939+
examples:
7940+
by-subject-digests:
7941+
summary: Delete by subject digests
7942+
value:
7943+
subject_digests:
7944+
- sha256:abc123
7945+
- sha512:def456
7946+
by-attestation-ids:
7947+
summary: Delete by attestation IDs
7948+
value:
7949+
attestation_ids:
7950+
- 111
7951+
- 222
7952+
responses:
7953+
'200':
7954+
description: Response
7955+
'404':
7956+
"$ref": "#/components/responses/not_found"
7957+
x-github:
7958+
githubCloudOnly: false
7959+
enabledForGitHubApps: true
7960+
category: orgs
7961+
subcategory: attestations
7962+
"/orgs/{org}/attestations/digest/{subject_digest}":
7963+
delete:
7964+
summary: Delete attestations by subject digest
7965+
description: Delete an artifact attestation by subject digest.
7966+
tags:
7967+
- orgs
7968+
operationId: orgs/delete-attestations-by-subject-digest
7969+
externalDocs:
7970+
description: API method documentation
7971+
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest
7972+
parameters:
7973+
- "$ref": "#/components/parameters/org"
7974+
- name: subject_digest
7975+
description: Subject Digest
7976+
in: path
7977+
required: true
7978+
schema:
7979+
type: string
7980+
x-multi-segment: true
7981+
responses:
7982+
'200':
7983+
description: Response
7984+
'204':
7985+
description: Response
7986+
'404':
7987+
"$ref": "#/components/responses/not_found"
7988+
x-github:
7989+
githubCloudOnly: false
7990+
enabledForGitHubApps: true
7991+
category: orgs
7992+
subcategory: attestations
7993+
"/orgs/{org}/attestations/{attestation_id}":
7994+
delete:
7995+
summary: Delete attestations by ID
7996+
description: Delete an artifact attestation by unique ID that is associated
7997+
with a repository owned by an org.
7998+
tags:
7999+
- orgs
8000+
operationId: orgs/delete-attestations-by-id
8001+
externalDocs:
8002+
description: API method documentation
8003+
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id
8004+
parameters:
8005+
- "$ref": "#/components/parameters/org"
8006+
- name: attestation_id
8007+
description: Attestation ID
8008+
in: path
8009+
required: true
8010+
schema:
8011+
type: integer
8012+
responses:
8013+
'200':
8014+
description: Response
8015+
'204':
8016+
description: Response
8017+
'403':
8018+
"$ref": "#/components/responses/forbidden"
8019+
'404':
8020+
"$ref": "#/components/responses/not_found"
8021+
x-github:
8022+
githubCloudOnly: false
8023+
enabledForGitHubApps: true
8024+
category: orgs
8025+
subcategory: attestations
78958026
"/orgs/{org}/attestations/{subject_digest}":
78968027
get:
78978028
summary: List attestations
@@ -50574,7 +50705,7 @@ paths:
5057450705
by-attestation-ids:
5057550706
summary: Delete by attestation IDs
5057650707
value:
50577-
subject_digests:
50708+
attestation_ids:
5057850709
- 111
5057950710
- 222
5058050711
responses:

0 commit comments

Comments
 (0)