diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 654d356d9c..486faba919 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -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", @@ -69891,7 +70083,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 09263558fc..0137b33cc9 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -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 @@ -50755,7 +50886,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 654d356d9c..486faba919 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -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", @@ -69891,7 +70083,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 09263558fc..0137b33cc9 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -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 @@ -50755,7 +50886,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 6c7ad13540..9b93863b42 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -76290,6 +76290,308 @@ } } }, + "/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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", @@ -615577,7 +615879,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e0591e9731..bd8440b692 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -21819,6 +21819,133 @@ 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: + - *90 + 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': *6 + 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: + - *90 + - 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': *6 + 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: + - *90 + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations @@ -101143,7 +101270,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 6c7ad13540..9b93863b42 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -76290,6 +76290,308 @@ } } }, + "/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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", @@ -615577,7 +615879,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index e0591e9731..bd8440b692 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -21819,6 +21819,133 @@ 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: + - *90 + 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': *6 + 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: + - *90 + - 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': *6 + 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: + - *90 + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations @@ -101143,7 +101270,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 7b33cac7d3..1b617c3b2a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -104844,6 +104844,308 @@ } } }, + "/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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", @@ -668036,7 +668338,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] @@ -882845,7 +883147,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -885181,7 +885483,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 0b5d0a86bf..ccde7ac4ba 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -30377,6 +30377,133 @@ 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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk + parameters: + - *165 + 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': *6 + 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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest + parameters: + - *165 + - 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': *6 + 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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id + parameters: + - *165 + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations @@ -112039,7 +112166,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: @@ -131871,9 +131998,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -131937,9 +132061,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 7b33cac7d3..1b617c3b2a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -104844,6 +104844,308 @@ } } }, + "/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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", @@ -668036,7 +668338,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] @@ -882845,7 +883147,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -885181,7 +885483,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 0b5d0a86bf..ccde7ac4ba 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -30377,6 +30377,133 @@ 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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk + parameters: + - *165 + 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': *6 + 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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest + parameters: + - *165 + - 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': *6 + 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/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id + parameters: + - *165 + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations @@ -112039,7 +112166,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: @@ -131871,9 +131998,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -131937,9 +132061,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 1acd6250ad..14d8ea0af3 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -16823,6 +16823,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", @@ -80258,7 +80450,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] @@ -88901,7 +89093,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -88994,7 +89186,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 92a378c17d..d9c3e6561c 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -12132,6 +12132,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 @@ -58157,7 +58288,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: @@ -64345,9 +64476,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -64412,9 +64540,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 1acd6250ad..14d8ea0af3 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -16823,6 +16823,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", @@ -80258,7 +80450,7 @@ "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { - "subject_digests": [ + "attestation_ids": [ 111, 222 ] @@ -88901,7 +89093,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -88994,7 +89186,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 92a378c17d..d9c3e6561c 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -12132,6 +12132,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 @@ -58157,7 +58288,7 @@ paths: by-attestation-ids: summary: Delete by attestation IDs value: - subject_digests: + attestation_ids: - 111 - 222 responses: @@ -64345,9 +64476,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -64412,9 +64540,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json index 449fe503dd..588a6594da 100644 --- a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json @@ -756912,7 +756912,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -759248,7 +759248,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml index eaff1ad705..75ec7d4774 100644 --- a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml @@ -115235,9 +115235,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -115301,9 +115298,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.json b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.json index 449fe503dd..588a6594da 100644 --- a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.json +++ b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.json @@ -756912,7 +756912,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -759248,7 +759248,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.yaml b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.yaml index eaff1ad705..75ec7d4774 100644 --- a/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.yaml +++ b/descriptions-next/ghes-3.17/dereferenced/ghes-3.17.deref.yaml @@ -115235,9 +115235,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -115301,9 +115298,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.json b/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.json index a67f5c0d28..83bd2c2eb8 100644 --- a/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.json +++ b/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.json @@ -76599,7 +76599,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -76692,7 +76692,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.yaml b/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.yaml index b67c9348e7..4c8b380ad8 100644 --- a/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.yaml +++ b/descriptions-next/ghes-3.17/ghes-3.17.2022-11-28.yaml @@ -55385,9 +55385,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -55452,9 +55449,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: diff --git a/descriptions-next/ghes-3.17/ghes-3.17.json b/descriptions-next/ghes-3.17/ghes-3.17.json index a67f5c0d28..83bd2c2eb8 100644 --- a/descriptions-next/ghes-3.17/ghes-3.17.json +++ b/descriptions-next/ghes-3.17/ghes-3.17.json @@ -76599,7 +76599,7 @@ }, "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { @@ -76692,7 +76692,7 @@ }, "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", "description": "A code scanning alert dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { diff --git a/descriptions-next/ghes-3.17/ghes-3.17.yaml b/descriptions-next/ghes-3.17/ghes-3.17.yaml index b67c9348e7..4c8b380ad8 100644 --- a/descriptions-next/ghes-3.17/ghes-3.17.yaml +++ b/descriptions-next/ghes-3.17/ghes-3.17.yaml @@ -55385,9 +55385,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: @@ -55452,9 +55449,6 @@ webhooks: This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. - - > [!NOTE] - > Delegated alert dismissal for code scanning is currently in public preview and subject to change. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: