Skip to content

Update OpenAPI 3.1 Descriptions #4977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2025
Merged

Update OpenAPI 3.1 Descriptions #4977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 193 additions & 1 deletion descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10908,6 +10908,198 @@
}
}
},
"/orgs/{org}/attestations/delete-request": {
"post": {
"summary": "Delete attestations in bulk",
"description": "Delete artifact attestations in bulk by either subject digests or unique ID.",
"tags": [
"orgs"
],
"operationId": "orgs/delete-attestations-bulk",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk"
},
"parameters": [
{
"$ref": "#/components/parameters/org"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"oneOf": [
{
"properties": {
"subject_digests": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subject digests associated with the artifact attestations to delete.",
"minItems": 1,
"maxItems": 1024
}
},
"required": [
"subject_digests"
]
},
{
"properties": {
"attestation_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of unique IDs associated with the artifact attestations to delete.",
"minItems": 1,
"maxItems": 1024
}
},
"required": [
"attestation_ids"
]
}
],
"description": "The request body must include either `subject_digests` or `attestation_ids`, but not both."
},
"examples": {
"by-subject-digests": {
"summary": "Delete by subject digests",
"value": {
"subject_digests": [
"sha256:abc123",
"sha512:def456"
]
}
},
"by-attestation-ids": {
"summary": "Delete by attestation IDs",
"value": {
"attestation_ids": [
111,
222
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Response"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "orgs",
"subcategory": "attestations"
}
}
},
"/orgs/{org}/attestations/digest/{subject_digest}": {
"delete": {
"summary": "Delete attestations by subject digest",
"description": "Delete an artifact attestation by subject digest.",
"tags": [
"orgs"
],
"operationId": "orgs/delete-attestations-by-subject-digest",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest"
},
"parameters": [
{
"$ref": "#/components/parameters/org"
},
{
"name": "subject_digest",
"description": "Subject Digest",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-multi-segment": true
}
],
"responses": {
"200": {
"description": "Response"
},
"204": {
"description": "Response"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "orgs",
"subcategory": "attestations"
}
}
},
"/orgs/{org}/attestations/{attestation_id}": {
"delete": {
"summary": "Delete attestations by ID",
"description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.",
"tags": [
"orgs"
],
"operationId": "orgs/delete-attestations-by-id",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id"
},
"parameters": [
{
"$ref": "#/components/parameters/org"
},
{
"name": "attestation_id",
"description": "Attestation ID",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Response"
},
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "orgs",
"subcategory": "attestations"
}
}
},
"/orgs/{org}/attestations/{subject_digest}": {
"get": {
"summary": "List attestations",
Expand Down Expand Up @@ -69891,7 +70083,7 @@
"by-attestation-ids": {
"summary": "Delete by attestation IDs",
"value": {
"subject_digests": [
"attestation_ids": [
111,
222
]
Expand Down
133 changes: 132 additions & 1 deletion descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7915,6 +7915,137 @@ paths:
enabledForGitHubApps: true
category: orgs
subcategory: orgs
"/orgs/{org}/attestations/delete-request":
post:
summary: Delete attestations in bulk
description: Delete artifact attestations in bulk by either subject digests
or unique ID.
tags:
- orgs
operationId: orgs/delete-attestations-bulk
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk
parameters:
- "$ref": "#/components/parameters/org"
requestBody:
required: true
content:
application/json:
schema:
type: object
oneOf:
- properties:
subject_digests:
type: array
items:
type: string
description: List of subject digests associated with the artifact
attestations to delete.
minItems: 1
maxItems: 1024
required:
- subject_digests
- properties:
attestation_ids:
type: array
items:
type: integer
description: List of unique IDs associated with the artifact attestations
to delete.
minItems: 1
maxItems: 1024
required:
- attestation_ids
description: The request body must include either `subject_digests`
or `attestation_ids`, but not both.
examples:
by-subject-digests:
summary: Delete by subject digests
value:
subject_digests:
- sha256:abc123
- sha512:def456
by-attestation-ids:
summary: Delete by attestation IDs
value:
attestation_ids:
- 111
- 222
responses:
'200':
description: Response
'404':
"$ref": "#/components/responses/not_found"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: attestations
"/orgs/{org}/attestations/digest/{subject_digest}":
delete:
summary: Delete attestations by subject digest
description: Delete an artifact attestation by subject digest.
tags:
- orgs
operationId: orgs/delete-attestations-by-subject-digest
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest
parameters:
- "$ref": "#/components/parameters/org"
- name: subject_digest
description: Subject Digest
in: path
required: true
schema:
type: string
x-multi-segment: true
responses:
'200':
description: Response
'204':
description: Response
'404':
"$ref": "#/components/responses/not_found"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: attestations
"/orgs/{org}/attestations/{attestation_id}":
delete:
summary: Delete attestations by ID
description: Delete an artifact attestation by unique ID that is associated
with a repository owned by an org.
tags:
- orgs
operationId: orgs/delete-attestations-by-id
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id
parameters:
- "$ref": "#/components/parameters/org"
- name: attestation_id
description: Attestation ID
in: path
required: true
schema:
type: integer
responses:
'200':
description: Response
'204':
description: Response
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: attestations
"/orgs/{org}/attestations/{subject_digest}":
get:
summary: List attestations
Expand Down Expand Up @@ -50755,7 +50886,7 @@ paths:
by-attestation-ids:
summary: Delete by attestation IDs
value:
subject_digests:
attestation_ids:
- 111
- 222
responses:
Expand Down
Loading